com.amazonaws.services.dynamodbv2.model

## クラス BatchWriteItemResult

- java.lang.Object
- - com.amazonaws.services.dynamodbv2.model.BatchWriteItemResult

- すべての実装されたインタフェース:
    java.io.Serializable

      public class BatchWriteItemResult
      extends java.lang.Object
      implements java.io.Serializable

  Represents the output of a BatchWriteItem operation.

  関連項目:
    直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `BatchWriteItemResult()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `BatchWriteItemResult` | `addItemCollectionMetricsEntry(java.lang.String key, java.util.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(java.lang.String key, java.util.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.
    `boolean` | `equals(java.lang.Object obj)`
    `java.util.List<ConsumedCapacity>` | `getConsumedCapacity()` The capacity units consumed by the operation.
    `java.util.Map<java.lang.String,java.util.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.
    `java.util.Map<java.lang.String,java.util.List<WriteRequest>>` | `getUnprocessedItems()` A map of tables and requests against those tables that were not processed.
    `int` | `hashCode()`
    `void` | `setConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity)` The capacity units consumed by the operation.
    `void` | `setItemCollectionMetrics(java.util.Map<java.lang.String,java.util.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(java.util.Map<java.lang.String,java.util.List<WriteRequest>> unprocessedItems)` A map of tables and requests against those tables that were not processed.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `BatchWriteItemResult` | `withConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity)` The capacity units consumed by the operation.
    `BatchWriteItemResult` | `withConsumedCapacity(ConsumedCapacity... consumedCapacity)` The capacity units consumed by the operation.
    `BatchWriteItemResult` | `withItemCollectionMetrics(java.util.Map<java.lang.String,java.util.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(java.util.Map<java.lang.String,java.util.List<WriteRequest>> unprocessedItems)` A map of tables and requests against those tables that were not processed.

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### BatchWriteItemResult

          public BatchWriteItemResult()

  - ### メソッドの詳細

    - #### getUnprocessedItems

          public java.util.Map<java.lang.String,java.util.List<WriteRequest>> getUnprocessedItems()

      A map of tables and requests against those tables that were not processed. The UnprocessedKeys 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.

          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.

      Constraints:
      Length: 1 - 25

      戻り値:
        A map of tables and requests against those tables that were not processed. The UnprocessedKeys 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.

            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.

    - #### setUnprocessedItems

          public void setUnprocessedItems(java.util.Map<java.lang.String,java.util.List<WriteRequest>> unprocessedItems)

      A map of tables and requests against those tables that were not processed. The UnprocessedKeys 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.

          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.

      Constraints:
      Length: 1 - 25

      パラメータ:
        `unprocessedItems` - A map of tables and requests against those tables that were not processed. The UnprocessedKeys 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.

            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.

    - #### withUnprocessedItems

          public BatchWriteItemResult withUnprocessedItems(java.util.Map<java.lang.String,java.util.List<WriteRequest>> unprocessedItems)

      A map of tables and requests against those tables that were not processed. The UnprocessedKeys 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.

          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.

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

      Constraints:
      Length: 1 - 25

      パラメータ:
        `unprocessedItems` - A map of tables and requests against those tables that were not processed. The UnprocessedKeys 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.

            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.

    - #### addUnprocessedItemsEntry

          public BatchWriteItemResult addUnprocessedItemsEntry(java.lang.String key,
                                                      java.util.List<WriteRequest> value)

      A map of tables and requests against those tables that were not processed. The UnprocessedKeys 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.

          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.

      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

      パラメータ:
        `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 java.util.Map<java.lang.String,java.util.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 secondary indexes on the table. Use this estimate to measure whether a 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.

      戻り値:
        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 secondary indexes on the table. Use this estimate to measure whether a 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(java.util.Map<java.lang.String,java.util.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 secondary indexes on the table. Use this estimate to measure whether a 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 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 secondary indexes on the table. Use this estimate to measure whether a 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(java.util.Map<java.lang.String,java.util.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 secondary indexes on the table. Use this estimate to measure whether a 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.

      パラメータ:
        `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 secondary indexes on the table. Use this estimate to measure whether a 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.

    - #### addItemCollectionMetricsEntry

          public BatchWriteItemResult addItemCollectionMetricsEntry(java.lang.String key,
                                                           java.util.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 secondary indexes on the table. Use this estimate to measure whether a 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.

      パラメータ:
        `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 java.util.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.

      戻り値:
        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(java.util.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.

      パラメータ:
        `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.

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

      パラメータ:
        `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(java.util.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.

      パラメータ:
        `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.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`