/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
/**
* <p>
* Represents the output of a <i>BatchWriteItem</i> operation.
* </p>
*/
public class BatchWriteItemResult implements Serializable {
/**
* <p>
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedItems</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section.
* </p>
* <p>
* Each <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>).
* </p>
* <ul>
* <li>
* <p>
* <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the
* specified item. The item to be deleted is identified by a <i>Key</i>
* subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Key</i> - 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.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified
* item. The item to be put is identified by an <i>Item</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Item</i> - 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
* <i>ValidationException</i> exception.
* </p>
* <p>
* 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.
* </p>
* </li>
* </ul>
* </li>
* </ul>
* <p>
* If there are no unprocessed items remaining, the response contains an
* empty <i>UnprocessedItems</i> map.
* </p>
*/
private java.util.Map<String, java.util.List<WriteRequest>> unprocessedItems;
/**
* <p>
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected by
* individual <i>DeleteItem</i> or <i>PutItem</i> operations.
* </p>
* <p>
* Each entry consists of the following subelements:
* </p>
* <ul>
* <li>
* <p>
* <i>ItemCollectionKey</i> - The partition key value of the item
* collection. This is the same as the partition key value of the item.
* </p>
* </li>
* <li>
* <p>
* <i>SizeEstimateRange</i> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on
* the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*/
private java.util.Map<String, java.util.List<ItemCollectionMetrics>> itemCollectionMetrics;
/**
* <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units consumed.
* </p>
* </li>
* </ul>
*/
private java.util.List<ConsumedCapacity> consumedCapacity;
/**
* <p>
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedItems</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section.
* </p>
* <p>
* Each <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>).
* </p>
* <ul>
* <li>
* <p>
* <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the
* specified item. The item to be deleted is identified by a <i>Key</i>
* subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Key</i> - 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.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified
* item. The item to be put is identified by an <i>Item</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Item</i> - 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
* <i>ValidationException</i> exception.
* </p>
* <p>
* 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.
* </p>
* </li>
* </ul>
* </li>
* </ul>
* <p>
* If there are no unprocessed items remaining, the response contains an
* empty <i>UnprocessedItems</i> map.
* </p>
*
* @return <p>
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedItems</i> value is in the same form
* as <i>RequestItems</i>, so you can provide this value directly to
* a subsequent <i>BatchGetItem</i> operation. For more information,
* see <i>RequestItems</i> in the Request Parameters section.
* </p>
* <p>
* Each <i>UnprocessedItems</i> entry consists of a table name and,
* for that table, a list of operations to perform
* (<i>DeleteRequest</i> or <i>PutRequest</i>).
* </p>
* <ul>
* <li>
* <p>
* <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on
* the specified item. The item to be deleted is identified by a
* <i>Key</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Key</i> - 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.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an
* <i>Item</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Item</i> - 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 <i>ValidationException</i> exception.
* </p>
* <p>
* 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.
* </p>
* </li>
* </ul>
* </li>
* </ul>
* <p>
* If there are no unprocessed items remaining, the response
* contains an empty <i>UnprocessedItems</i> map.
* </p>
*/
public java.util.Map<String, java.util.List<WriteRequest>> getUnprocessedItems() {
return unprocessedItems;
}
/**
* <p>
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedItems</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section.
* </p>
* <p>
* Each <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>).
* </p>
* <ul>
* <li>
* <p>
* <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the
* specified item. The item to be deleted is identified by a <i>Key</i>
* subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Key</i> - 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.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified
* item. The item to be put is identified by an <i>Item</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Item</i> - 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
* <i>ValidationException</i> exception.
* </p>
* <p>
* 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.
* </p>
* </li>
* </ul>
* </li>
* </ul>
* <p>
* If there are no unprocessed items remaining, the response contains an
* empty <i>UnprocessedItems</i> map.
* </p>
*
* @param unprocessedItems <p>
* A map of tables and requests against those tables that were
* not processed. The <i>UnprocessedItems</i> value is in the
* same form as <i>RequestItems</i>, so you can provide this
* value directly to a subsequent <i>BatchGetItem</i> operation.
* For more information, see <i>RequestItems</i> in the Request
* Parameters section.
* </p>
* <p>
* Each <i>UnprocessedItems</i> entry consists of a table name
* and, for that table, a list of operations to perform
* (<i>DeleteRequest</i> or <i>PutRequest</i>).
* </p>
* <ul>
* <li>
* <p>
* <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation
* on the specified item. The item to be deleted is identified by
* a <i>Key</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Key</i> - 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.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an
* <i>Item</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Item</i> - 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 <i>ValidationException</i>
* exception.
* </p>
* <p>
* 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.
* </p>
* </li>
* </ul>
* </li>
* </ul>
* <p>
* If there are no unprocessed items remaining, the response
* contains an empty <i>UnprocessedItems</i> map.
* </p>
*/
public void setUnprocessedItems(
java.util.Map<String, java.util.List<WriteRequest>> unprocessedItems) {
this.unprocessedItems = unprocessedItems;
}
/**
* <p>
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedItems</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section.
* </p>
* <p>
* Each <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>).
* </p>
* <ul>
* <li>
* <p>
* <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the
* specified item. The item to be deleted is identified by a <i>Key</i>
* subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Key</i> - 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.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified
* item. The item to be put is identified by an <i>Item</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Item</i> - 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
* <i>ValidationException</i> exception.
* </p>
* <p>
* 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.
* </p>
* </li>
* </ul>
* </li>
* </ul>
* <p>
* If there are no unprocessed items remaining, the response contains an
* empty <i>UnprocessedItems</i> map.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param unprocessedItems <p>
* A map of tables and requests against those tables that were
* not processed. The <i>UnprocessedItems</i> value is in the
* same form as <i>RequestItems</i>, so you can provide this
* value directly to a subsequent <i>BatchGetItem</i> operation.
* For more information, see <i>RequestItems</i> in the Request
* Parameters section.
* </p>
* <p>
* Each <i>UnprocessedItems</i> entry consists of a table name
* and, for that table, a list of operations to perform
* (<i>DeleteRequest</i> or <i>PutRequest</i>).
* </p>
* <ul>
* <li>
* <p>
* <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation
* on the specified item. The item to be deleted is identified by
* a <i>Key</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Key</i> - 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.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an
* <i>Item</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Item</i> - 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 <i>ValidationException</i>
* exception.
* </p>
* <p>
* 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.
* </p>
* </li>
* </ul>
* </li>
* </ul>
* <p>
* If there are no unprocessed items remaining, the response
* contains an empty <i>UnprocessedItems</i> map.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public BatchWriteItemResult withUnprocessedItems(
java.util.Map<String, java.util.List<WriteRequest>> unprocessedItems) {
this.unprocessedItems = unprocessedItems;
return this;
}
/**
* <p>
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedItems</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section.
* </p>
* <p>
* Each <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>).
* </p>
* <ul>
* <li>
* <p>
* <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the
* specified item. The item to be deleted is identified by a <i>Key</i>
* subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Key</i> - 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.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified
* item. The item to be put is identified by an <i>Item</i> subelement:
* </p>
* <ul>
* <li>
* <p>
* <i>Item</i> - 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
* <i>ValidationException</i> exception.
* </p>
* <p>
* 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.
* </p>
* </li>
* </ul>
* </li>
* </ul>
* <p>
* If there are no unprocessed items remaining, the response contains an
* empty <i>UnprocessedItems</i> map.
* </p>
* <p>
* 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.
*
* @param key The key of the entry to be added into UnprocessedItems.
* @param value The corresponding value of the entry to be added into
* UnprocessedItems.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public BatchWriteItemResult addUnprocessedItemsEntry(String key,
java.util.List<WriteRequest> value) {
if (null == this.unprocessedItems) {
this.unprocessedItems = new java.util.HashMap<String, java.util.List<WriteRequest>>();
}
if (this.unprocessedItems.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString()
+ ") are provided.");
this.unprocessedItems.put(key, value);
return this;
}
/**
* Removes all the entries added into UnprocessedItems.
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*/
public BatchWriteItemResult clearUnprocessedItemsEntries() {
this.unprocessedItems = null;
return this;
}
/**
* <p>
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected by
* individual <i>DeleteItem</i> or <i>PutItem</i> operations.
* </p>
* <p>
* Each entry consists of the following subelements:
* </p>
* <ul>
* <li>
* <p>
* <i>ItemCollectionKey</i> - The partition key value of the item
* collection. This is the same as the partition key value of the item.
* </p>
* </li>
* <li>
* <p>
* <i>SizeEstimateRange</i> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on
* the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*
* @return <p>
* A list of tables that were processed by <i>BatchWriteItem</i>
* and, for each table, information about any item collections that
* were affected by individual <i>DeleteItem</i> or <i>PutItem</i>
* operations.
* </p>
* <p>
* Each entry consists of the following subelements:
* </p>
* <ul>
* <li>
* <p>
* <i>ItemCollectionKey</i> - The partition key value of the item
* collection. This is the same as the partition key value of the
* item.
* </p>
* </li>
* <li>
* <p>
* <i>SizeEstimateRange</i> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not
* rely on the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*/
public java.util.Map<String, java.util.List<ItemCollectionMetrics>> getItemCollectionMetrics() {
return itemCollectionMetrics;
}
/**
* <p>
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected by
* individual <i>DeleteItem</i> or <i>PutItem</i> operations.
* </p>
* <p>
* Each entry consists of the following subelements:
* </p>
* <ul>
* <li>
* <p>
* <i>ItemCollectionKey</i> - The partition key value of the item
* collection. This is the same as the partition key value of the item.
* </p>
* </li>
* <li>
* <p>
* <i>SizeEstimateRange</i> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on
* the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*
* @param itemCollectionMetrics <p>
* A list of tables that were processed by <i>BatchWriteItem</i>
* and, for each table, information about any item collections
* that were affected by individual <i>DeleteItem</i> or
* <i>PutItem</i> operations.
* </p>
* <p>
* Each entry consists of the following subelements:
* </p>
* <ul>
* <li>
* <p>
* <i>ItemCollectionKey</i> - The partition key value of the item
* collection. This is the same as the partition key value of the
* item.
* </p>
* </li>
* <li>
* <p>
* <i>SizeEstimateRange</i> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not
* rely on the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*/
public void setItemCollectionMetrics(
java.util.Map<String, java.util.List<ItemCollectionMetrics>> itemCollectionMetrics) {
this.itemCollectionMetrics = itemCollectionMetrics;
}
/**
* <p>
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected by
* individual <i>DeleteItem</i> or <i>PutItem</i> operations.
* </p>
* <p>
* Each entry consists of the following subelements:
* </p>
* <ul>
* <li>
* <p>
* <i>ItemCollectionKey</i> - The partition key value of the item
* collection. This is the same as the partition key value of the item.
* </p>
* </li>
* <li>
* <p>
* <i>SizeEstimateRange</i> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on
* the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param itemCollectionMetrics <p>
* A list of tables that were processed by <i>BatchWriteItem</i>
* and, for each table, information about any item collections
* that were affected by individual <i>DeleteItem</i> or
* <i>PutItem</i> operations.
* </p>
* <p>
* Each entry consists of the following subelements:
* </p>
* <ul>
* <li>
* <p>
* <i>ItemCollectionKey</i> - The partition key value of the item
* collection. This is the same as the partition key value of the
* item.
* </p>
* </li>
* <li>
* <p>
* <i>SizeEstimateRange</i> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not
* rely on the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public BatchWriteItemResult withItemCollectionMetrics(
java.util.Map<String, java.util.List<ItemCollectionMetrics>> itemCollectionMetrics) {
this.itemCollectionMetrics = itemCollectionMetrics;
return this;
}
/**
* <p>
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected by
* individual <i>DeleteItem</i> or <i>PutItem</i> operations.
* </p>
* <p>
* Each entry consists of the following subelements:
* </p>
* <ul>
* <li>
* <p>
* <i>ItemCollectionKey</i> - The partition key value of the item
* collection. This is the same as the partition key value of the item.
* </p>
* </li>
* <li>
* <p>
* <i>SizeEstimateRange</i> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on
* the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
* <p>
* 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.
*
* @param key The key of the entry to be added into ItemCollectionMetrics.
* @param value The corresponding value of the entry to be added into
* ItemCollectionMetrics.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public BatchWriteItemResult addItemCollectionMetricsEntry(String key,
java.util.List<ItemCollectionMetrics> value) {
if (null == this.itemCollectionMetrics) {
this.itemCollectionMetrics = new java.util.HashMap<String, java.util.List<ItemCollectionMetrics>>();
}
if (this.itemCollectionMetrics.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString()
+ ") are provided.");
this.itemCollectionMetrics.put(key, value);
return this;
}
/**
* Removes all the entries added into ItemCollectionMetrics.
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*/
public BatchWriteItemResult clearItemCollectionMetricsEntries() {
this.itemCollectionMetrics = null;
return this;
}
/**
* <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units consumed.
* </p>
* </li>
* </ul>
*
* @return <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned
* throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units
* consumed.
* </p>
* </li>
* </ul>
*/
public java.util.List<ConsumedCapacity> getConsumedCapacity() {
return consumedCapacity;
}
/**
* <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units consumed.
* </p>
* </li>
* </ul>
*
* @param consumedCapacity <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned
* throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units
* consumed.
* </p>
* </li>
* </ul>
*/
public void setConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity) {
if (consumedCapacity == null) {
this.consumedCapacity = null;
return;
}
this.consumedCapacity = new java.util.ArrayList<ConsumedCapacity>(consumedCapacity);
}
/**
* <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units consumed.
* </p>
* </li>
* </ul>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param consumedCapacity <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned
* throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units
* consumed.
* </p>
* </li>
* </ul>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public BatchWriteItemResult withConsumedCapacity(ConsumedCapacity... consumedCapacity) {
if (getConsumedCapacity() == null) {
this.consumedCapacity = new java.util.ArrayList<ConsumedCapacity>(
consumedCapacity.length);
}
for (ConsumedCapacity value : consumedCapacity) {
this.consumedCapacity.add(value);
}
return this;
}
/**
* <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units consumed.
* </p>
* </li>
* </ul>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param consumedCapacity <p>
* The capacity units consumed by the operation.
* </p>
* <p>
* Each element consists of:
* </p>
* <ul>
* <li>
* <p>
* <i>TableName</i> - The table that consumed the provisioned
* throughput.
* </p>
* </li>
* <li>
* <p>
* <i>CapacityUnits</i> - The total number of capacity units
* consumed.
* </p>
* </li>
* </ul>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public BatchWriteItemResult withConsumedCapacity(
java.util.Collection<ConsumedCapacity> consumedCapacity) {
setConsumedCapacity(consumedCapacity);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUnprocessedItems() != null)
sb.append("UnprocessedItems: " + getUnprocessedItems() + ",");
if (getItemCollectionMetrics() != null)
sb.append("ItemCollectionMetrics: " + getItemCollectionMetrics() + ",");
if (getConsumedCapacity() != null)
sb.append("ConsumedCapacity: " + getConsumedCapacity());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getUnprocessedItems() == null) ? 0 : getUnprocessedItems().hashCode());
hashCode = prime
* hashCode
+ ((getItemCollectionMetrics() == null) ? 0 : getItemCollectionMetrics().hashCode());
hashCode = prime * hashCode
+ ((getConsumedCapacity() == null) ? 0 : getConsumedCapacity().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchWriteItemResult == false)
return false;
BatchWriteItemResult other = (BatchWriteItemResult) obj;
if (other.getUnprocessedItems() == null ^ this.getUnprocessedItems() == null)
return false;
if (other.getUnprocessedItems() != null
&& other.getUnprocessedItems().equals(this.getUnprocessedItems()) == false)
return false;
if (other.getItemCollectionMetrics() == null ^ this.getItemCollectionMetrics() == null)
return false;
if (other.getItemCollectionMetrics() != null
&& other.getItemCollectionMetrics().equals(this.getItemCollectionMetrics()) == false)
return false;
if (other.getConsumedCapacity() == null ^ this.getConsumedCapacity() == null)
return false;
if (other.getConsumedCapacity() != null
&& other.getConsumedCapacity().equals(this.getConsumedCapacity()) == false)
return false;
return true;
}
}