@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BatchWriteItemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents the output of a BatchWriteItem
operation.
Constructor and Description |
---|
BatchWriteItemResult() |
Modifier and Type | Method and Description |
---|---|
BatchWriteItemResult |
addItemCollectionMetricsEntry(String key,
List<ItemCollectionMetrics> value)
Add a single ItemCollectionMetrics entry
|
BatchWriteItemResult |
addUnprocessedItemsEntry(String key,
List<WriteRequest> value)
Add a single UnprocessedItems entry
|
BatchWriteItemResult |
clearItemCollectionMetricsEntries()
Removes all the entries added into ItemCollectionMetrics.
|
BatchWriteItemResult |
clearUnprocessedItemsEntries()
Removes all the entries added into UnprocessedItems.
|
BatchWriteItemResult |
clone() |
boolean |
equals(Object obj) |
List<ConsumedCapacity> |
getConsumedCapacity()
The capacity units consumed by the entire
BatchWriteItem operation. |
Map<String,List<ItemCollectionMetrics>> |
getItemCollectionMetrics()
A list of tables that were processed by
BatchWriteItem and, for each table, information about any
item collections that were affected by individual DeleteItem or PutItem operations. |
Map<String,List<WriteRequest>> |
getUnprocessedItems()
A map of tables and requests against those tables that were not processed.
|
int |
hashCode() |
void |
setConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)
The capacity units consumed by the entire
BatchWriteItem operation. |
void |
setItemCollectionMetrics(Map<String,List<ItemCollectionMetrics>> itemCollectionMetrics)
A list of tables that were processed by
BatchWriteItem and, for each table, information about any
item collections that were affected by individual DeleteItem or PutItem operations. |
void |
setUnprocessedItems(Map<String,List<WriteRequest>> unprocessedItems)
A map of tables and requests against those tables that were not processed.
|
String |
toString()
Returns a string representation of this object.
|
BatchWriteItemResult |
withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)
The capacity units consumed by the entire
BatchWriteItem operation. |
BatchWriteItemResult |
withConsumedCapacity(ConsumedCapacity... consumedCapacity)
The capacity units consumed by the entire
BatchWriteItem operation. |
BatchWriteItemResult |
withItemCollectionMetrics(Map<String,List<ItemCollectionMetrics>> itemCollectionMetrics)
A list of tables that were processed by
BatchWriteItem and, for each table, information about any
item collections that were affected by individual DeleteItem or PutItem operations. |
BatchWriteItemResult |
withUnprocessedItems(Map<String,List<WriteRequest>> unprocessedItems)
A map of tables and requests against those tables that were not processed.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public Map<String,List<WriteRequest>> getUnprocessedItems()
A map of tables and requests against those tables that were not processed. The UnprocessedItems
value is in the same form as RequestItems
, so you can provide this value directly to a subsequent
BatchGetItem
operation. For more information, see RequestItems
in the Request
Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that table, a list of operations to
perform (DeleteRequest
or PutRequest
).
DeleteRequest
- Perform a DeleteItem
operation on the specified item. The item to be
deleted is identified by a Key
subelement:
Key
- A map of primary key attribute values that uniquely identify the item. Each entry in this map
consists of an attribute name and an attribute value.
PutRequest
- Perform a PutItem
operation on the specified item. The item to be put is
identified by an Item
subelement:
Item
- A map of attributes and their values. Each entry in this map consists of an attribute name
and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths
greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected
with a ValidationException
exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems
map.
UnprocessedItems
value is in the same form as RequestItems
, so you can provide
this value directly to a subsequent BatchGetItem
operation. For more information, see
RequestItems
in the Request Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that table, a list of
operations to perform (DeleteRequest
or PutRequest
).
DeleteRequest
- Perform a DeleteItem
operation on the specified item. The item
to be deleted is identified by a Key
subelement:
Key
- A map of primary key attribute values that uniquely identify the item. Each entry in
this map consists of an attribute name and an attribute value.
PutRequest
- Perform a PutItem
operation on the specified item. The item to be
put is identified by an Item
subelement:
Item
- A map of attributes and their values. Each entry in this map consists of an attribute
name and an attribute value. Attribute values must not be null; string and binary type attributes must
have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty
values will be rejected with a ValidationException
exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems
map.
public void setUnprocessedItems(Map<String,List<WriteRequest>> unprocessedItems)
A map of tables and requests against those tables that were not processed. The UnprocessedItems
value is in the same form as RequestItems
, so you can provide this value directly to a subsequent
BatchGetItem
operation. For more information, see RequestItems
in the Request
Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that table, a list of operations to
perform (DeleteRequest
or PutRequest
).
DeleteRequest
- Perform a DeleteItem
operation on the specified item. The item to be
deleted is identified by a Key
subelement:
Key
- A map of primary key attribute values that uniquely identify the item. Each entry in this map
consists of an attribute name and an attribute value.
PutRequest
- Perform a PutItem
operation on the specified item. The item to be put is
identified by an Item
subelement:
Item
- A map of attributes and their values. Each entry in this map consists of an attribute name
and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths
greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected
with a ValidationException
exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems
map.
unprocessedItems
- A map of tables and requests against those tables that were not processed. The
UnprocessedItems
value is in the same form as RequestItems
, so you can provide
this value directly to a subsequent BatchGetItem
operation. For more information, see
RequestItems
in the Request Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that table, a list of
operations to perform (DeleteRequest
or PutRequest
).
DeleteRequest
- Perform a DeleteItem
operation on the specified item. The item
to be deleted is identified by a Key
subelement:
Key
- A map of primary key attribute values that uniquely identify the item. Each entry in
this map consists of an attribute name and an attribute value.
PutRequest
- Perform a PutItem
operation on the specified item. The item to be
put is identified by an Item
subelement:
Item
- A map of attributes and their values. Each entry in this map consists of an attribute
name and an attribute value. Attribute values must not be null; string and binary type attributes must
have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty
values will be rejected with a ValidationException
exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems
map.
public BatchWriteItemResult withUnprocessedItems(Map<String,List<WriteRequest>> unprocessedItems)
A map of tables and requests against those tables that were not processed. The UnprocessedItems
value is in the same form as RequestItems
, so you can provide this value directly to a subsequent
BatchGetItem
operation. For more information, see RequestItems
in the Request
Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that table, a list of operations to
perform (DeleteRequest
or PutRequest
).
DeleteRequest
- Perform a DeleteItem
operation on the specified item. The item to be
deleted is identified by a Key
subelement:
Key
- A map of primary key attribute values that uniquely identify the item. Each entry in this map
consists of an attribute name and an attribute value.
PutRequest
- Perform a PutItem
operation on the specified item. The item to be put is
identified by an Item
subelement:
Item
- A map of attributes and their values. Each entry in this map consists of an attribute name
and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths
greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected
with a ValidationException
exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems
map.
unprocessedItems
- A map of tables and requests against those tables that were not processed. The
UnprocessedItems
value is in the same form as RequestItems
, so you can provide
this value directly to a subsequent BatchGetItem
operation. For more information, see
RequestItems
in the Request Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that table, a list of
operations to perform (DeleteRequest
or PutRequest
).
DeleteRequest
- Perform a DeleteItem
operation on the specified item. The item
to be deleted is identified by a Key
subelement:
Key
- A map of primary key attribute values that uniquely identify the item. Each entry in
this map consists of an attribute name and an attribute value.
PutRequest
- Perform a PutItem
operation on the specified item. The item to be
put is identified by an Item
subelement:
Item
- A map of attributes and their values. Each entry in this map consists of an attribute
name and an attribute value. Attribute values must not be null; string and binary type attributes must
have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty
values will be rejected with a ValidationException
exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems
map.
public BatchWriteItemResult addUnprocessedItemsEntry(String key, List<WriteRequest> value)
public BatchWriteItemResult clearUnprocessedItemsEntries()
public Map<String,List<ItemCollectionMetrics>> getItemCollectionMetrics()
A list of tables that were processed by BatchWriteItem
and, for each table, information about any
item collections that were affected by individual DeleteItem
or PutItem
operations.
Each entry consists of the following subelements:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the
partition key value of the item.
SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This is a two-element
array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
items in the table, plus the size of all attributes projected into all of the local secondary indexes on the
table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
BatchWriteItem
and, for each table, information
about any item collections that were affected by individual DeleteItem
or
PutItem
operations.
Each entry consists of the following subelements:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the
partition key value of the item.
SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This is a
two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the
size of all the items in the table, plus the size of all attributes projected into all of the local
secondary indexes on the table. Use this estimate to measure whether a local secondary index is
approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
public void setItemCollectionMetrics(Map<String,List<ItemCollectionMetrics>> itemCollectionMetrics)
A list of tables that were processed by BatchWriteItem
and, for each table, information about any
item collections that were affected by individual DeleteItem
or PutItem
operations.
Each entry consists of the following subelements:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the
partition key value of the item.
SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This is a two-element
array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
items in the table, plus the size of all attributes projected into all of the local secondary indexes on the
table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
itemCollectionMetrics
- A list of tables that were processed by BatchWriteItem
and, for each table, information about
any item collections that were affected by individual DeleteItem
or PutItem
operations.
Each entry consists of the following subelements:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the
partition key value of the item.
SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This is a
two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the
size of all the items in the table, plus the size of all attributes projected into all of the local
secondary indexes on the table. Use this estimate to measure whether a local secondary index is
approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
public BatchWriteItemResult withItemCollectionMetrics(Map<String,List<ItemCollectionMetrics>> itemCollectionMetrics)
A list of tables that were processed by BatchWriteItem
and, for each table, information about any
item collections that were affected by individual DeleteItem
or PutItem
operations.
Each entry consists of the following subelements:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the
partition key value of the item.
SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This is a two-element
array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
items in the table, plus the size of all attributes projected into all of the local secondary indexes on the
table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
itemCollectionMetrics
- A list of tables that were processed by BatchWriteItem
and, for each table, information about
any item collections that were affected by individual DeleteItem
or PutItem
operations.
Each entry consists of the following subelements:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the
partition key value of the item.
SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This is a
two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the
size of all the items in the table, plus the size of all attributes projected into all of the local
secondary indexes on the table. Use this estimate to measure whether a local secondary index is
approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
public BatchWriteItemResult addItemCollectionMetricsEntry(String key, List<ItemCollectionMetrics> value)
public BatchWriteItemResult clearItemCollectionMetricsEntries()
public List<ConsumedCapacity> getConsumedCapacity()
The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
public void setConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)
The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
consumedCapacity
- The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
public BatchWriteItemResult withConsumedCapacity(ConsumedCapacity... consumedCapacity)
The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
NOTE: This method appends the values to the existing list (if any). Use
setConsumedCapacity(java.util.Collection)
or withConsumedCapacity(java.util.Collection)
if you
want to override the existing values.
consumedCapacity
- The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
public BatchWriteItemResult withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)
The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
consumedCapacity
- The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
public String toString()
toString
in class Object
Object.toString()
public BatchWriteItemResult clone()
Copyright © 2020. All rights reserved.