com.amazonaws.services.dynamodbv2.model

## クラス BatchGetItemResult

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

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

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

  Represents the output of a BatchGetItem operation.

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `BatchGetItemResult` | `addResponsesEntry(java.lang.String key, java.util.List<java.util.Map<java.lang.String,AttributeValue>> value)` A map of table name to a list of items.
    `BatchGetItemResult` | `addUnprocessedKeysEntry(java.lang.String key, KeysAndAttributes value)` A map of tables and their respective keys that were not processed with the current response.
    `BatchGetItemResult` | `clearResponsesEntries()` Removes all the entries added into Responses.
    `BatchGetItemResult` | `clearUnprocessedKeysEntries()` Removes all the entries added into UnprocessedKeys.
    `boolean` | `equals(java.lang.Object obj)`
    `java.util.List<ConsumedCapacity>` | `getConsumedCapacity()` The write capacity units consumed by the operation.
    `java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>>` | `getResponses()` A map of table name to a list of items.
    `java.util.Map<java.lang.String,KeysAndAttributes>` | `getUnprocessedKeys()` A map of tables and their respective keys that were not processed with the current response.
    `int` | `hashCode()`
    `void` | `setConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity)` The write capacity units consumed by the operation.
    `void` | `setResponses(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses)` A map of table name to a list of items.
    `void` | `setUnprocessedKeys(java.util.Map<java.lang.String,KeysAndAttributes> unprocessedKeys)` A map of tables and their respective keys that were not processed with the current response.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `BatchGetItemResult` | `withConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity)` The write capacity units consumed by the operation.
    `BatchGetItemResult` | `withConsumedCapacity(ConsumedCapacity... consumedCapacity)` The write capacity units consumed by the operation.
    `BatchGetItemResult` | `withResponses(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses)` A map of table name to a list of items.
    `BatchGetItemResult` | `withUnprocessedKeys(java.util.Map<java.lang.String,KeysAndAttributes> unprocessedKeys)` A map of tables and their respective keys that were not processed with the current response.

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

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

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

    - #### BatchGetItemResult

          public BatchGetItemResult()

  - ### メソッドの詳細

    - #### getResponses

          public java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> getResponses()

      A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
      戻り値:
        A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

    - #### setResponses

          public void setResponses(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses)

      A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
      パラメータ:
        `responses` - A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

    - #### withResponses

          public BatchGetItemResult withResponses(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses)

      A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

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

      パラメータ:
        `responses` - A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

    - #### addResponsesEntry

          public BatchGetItemResult addResponsesEntry(java.lang.String key,
                                             java.util.List<java.util.Map<java.lang.String,AttributeValue>> value)

      A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

      The method adds a new key-value pair into Responses 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 Responses.
        `value` - The corresponding value of the entry to be added into Responses.

    - #### clearResponsesEntries

          public BatchGetItemResult clearResponsesEntries()

      Removes all the entries added into Responses.

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

    - #### getUnprocessedKeys

          public java.util.Map<java.lang.String,KeysAndAttributes> getUnprocessedKeys()

      A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

      Each element consists of:

      - Keys - An array of primary key attribute values that define specific items in the table.

      - AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.

      If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

    - ConsistentRead - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

    Constraints:
    Length: 1 - 100

戻り値:
  A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

  Each element consists of:

  - Keys - An array of primary key attribute values that define specific items in the table.

  - AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.

  If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

  - ConsistentRead - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

- #### setUnprocessedKeys

      public void setUnprocessedKeys(java.util.Map<java.lang.String,KeysAndAttributes> unprocessedKeys)

  A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

  Each element consists of:

  - Keys - An array of primary key attribute values that define specific items in the table.

  - AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.

  If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

- ConsistentRead - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Constraints:
Length: 1 - 100

パラメータ:
  `unprocessedKeys` - A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

  Each element consists of:

  - Keys - An array of primary key attribute values that define specific items in the table.

  - AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.

  If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

  - ConsistentRead - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

- #### withUnprocessedKeys

      public BatchGetItemResult withUnprocessedKeys(java.util.Map<java.lang.String,KeysAndAttributes> unprocessedKeys)

  A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

  Each element consists of:

  - Keys - An array of primary key attribute values that define specific items in the table.

  - AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.

  If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

- ConsistentRead - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

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

Constraints:
Length: 1 - 100

パラメータ:
  `unprocessedKeys` - A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

  Each element consists of:

  - Keys - An array of primary key attribute values that define specific items in the table.

  - AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.

  If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

  - ConsistentRead - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

- #### addUnprocessedKeysEntry

      public BatchGetItemResult addUnprocessedKeysEntry(java.lang.String key,
                                               KeysAndAttributes value)

  A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

  Each element consists of:

  - Keys - An array of primary key attribute values that define specific items in the table.

  - AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.

  If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

- ConsistentRead - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

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

Constraints:
Length: 1 - 100

パラメータ:
  `key` - The key of the entry to be added into UnprocessedKeys.
  `value` - The corresponding value of the entry to be added into UnprocessedKeys.

- #### clearUnprocessedKeysEntries

      public BatchGetItemResult clearUnprocessedKeysEntries()

  Removes all the entries added into UnprocessedKeys.

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

- #### getConsumedCapacity

      public java.util.List<ConsumedCapacity> getConsumedCapacity()

  The write 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 write 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 write 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 write 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 BatchGetItemResult withConsumedCapacity(ConsumedCapacity... consumedCapacity)

  The write 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 write 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 BatchGetItemResult withConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity)

  The write 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 write 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`