com.amazonaws.services.dynamodbv2.model

Class BatchWriteItemResult

java.lang.Object

com.amazonaws.services.dynamodbv2.model.BatchWriteItemResult

All Implemented Interfaces:

Serializable, Cloneable

public class BatchWriteItemResult
extends Object
implements Serializable, Cloneable

Represents the output of a BatchWriteItem operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BatchWriteItemResult()

Method Summary

Methods

Modifier and Type	Method and Description
BatchWriteItemResult	addItemCollectionMetricsEntry(String key, List<ItemCollectionMetrics> value) 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	addUnprocessedItemsEntry(String key, List<WriteRequest> value) A map of tables and requests against those tables that were not processed.
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 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 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; useful for testing and debugging.
BatchWriteItemResult	withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity) The capacity units consumed by the operation.
BatchWriteItemResult	withConsumedCapacity(ConsumedCapacity... consumedCapacity) The capacity units consumed by the 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.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchWriteItemResult

public BatchWriteItemResult()

Method Detail

getUnprocessedItems

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.

Constraints:
Length: 1 - 25

Returns:

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.

setUnprocessedItems

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.

Constraints:
Length: 1 - 25

Parameters:

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.

withUnprocessedItems

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 25

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

addUnprocessedItemsEntry

public BatchWriteItemResult addUnprocessedItemsEntry(String key,
                                            List<WriteRequest> value)

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.

The method adds a new key-value pair into UnprocessedItems parameter, and returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 25

Parameters:

key - The key of the entry to be added into UnprocessedItems.

value - The corresponding value of the entry to be added into UnprocessedItems.

clearUnprocessedItemsEntries

public BatchWriteItemResult clearUnprocessedItemsEntries()

Removes all the entries added into UnprocessedItems.

Returns a reference to this object so that method calls can be chained together.

getItemCollectionMetrics

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 hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - 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.

Returns:

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 hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - 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.

setItemCollectionMetrics

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 hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - 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.

Parameters:

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 hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - 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.

withItemCollectionMetrics

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 hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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 hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - 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.

Returns:

A reference to this updated object so that method calls can be chained together.

addItemCollectionMetricsEntry

public BatchWriteItemResult addItemCollectionMetricsEntry(String key,
                                                 List<ItemCollectionMetrics> value)

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 hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - 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.

The method adds a new key-value pair into ItemCollectionMetrics parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into ItemCollectionMetrics.

value - The corresponding value of the entry to be added into ItemCollectionMetrics.

clearItemCollectionMetricsEntries

public BatchWriteItemResult clearItemCollectionMetricsEntries()

Removes all the entries added into ItemCollectionMetrics.

Returns a reference to this object so that method calls can be chained together.

getConsumedCapacity

public List<ConsumedCapacity> getConsumedCapacity()

The capacity units consumed by the operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

Returns:

The capacity units consumed by the operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

setConsumedCapacity

public void setConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)

The capacity units consumed by the operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

Parameters:

consumedCapacity - The capacity units consumed by the operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

withConsumedCapacity

public BatchWriteItemResult withConsumedCapacity(ConsumedCapacity... consumedCapacity)

The capacity units consumed by the 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

consumedCapacity - The capacity units consumed by the operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

Returns:

A reference to this updated object so that method calls can be chained together.

withConsumedCapacity

public BatchWriteItemResult withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)

The capacity units consumed by the operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

consumedCapacity - The capacity units consumed by the operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public BatchWriteItemResult clone()

Overrides:

clone in class Object