BatchGetItemResult (AWS SDK for Java

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

All Implemented Interfaces:

Serializable
```
public class BatchGetItemResult
extends Object
implements Serializable
```
Represents the output of a BatchGetItem operation.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchGetItemResult()

Constructors
Constructor and Description
`BatchGetItemResult()`

Method Summary

Methods
Modifier and Type	Method and Description
`BatchGetItemResult`	`addResponsesEntry(String key, List<Map<String,AttributeValue>> value)` A map of table name to a list of items.
`BatchGetItemResult`	`addUnprocessedKeysEntry(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(Object obj)`
`List<ConsumedCapacity>`	`getConsumedCapacity()` The write capacity units consumed by the operation.
`Map<String,List<Map<String,AttributeValue>>>`	`getResponses()` A map of table name to a list of items.
`Map<String,KeysAndAttributes>`	`getUnprocessedKeys()` A map of tables and their respective keys that were not processed with the current response.
`int`	`hashCode()`
`void`	`setConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)` The write capacity units consumed by the operation.
`void`	`setResponses(Map<String,List<Map<String,AttributeValue>>> responses)` A map of table name to a list of items.
`void`	`setUnprocessedKeys(Map<String,KeysAndAttributes> unprocessedKeys)` A map of tables and their respective keys that were not processed with the current response.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BatchGetItemResult`	`withConsumedCapacity(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(Map<String,List<Map<String,AttributeValue>>> responses)` A map of table name to a list of items.
`BatchGetItemResult`	`withUnprocessedKeys(Map<String,KeysAndAttributes> unprocessedKeys)` A map of tables and their respective keys that were not processed with the current response.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchGetItemResult
```
public BatchGetItemResult()
```
- Method Detail
  - getResponses
```
public Map<String,List<Map<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.
    
    Returns:
    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(Map<String,List<Map<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.
    
    Parameters:
    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(Map<String,List<Map<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.
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - addResponsesEntry
```
public BatchGetItemResult addResponsesEntry(String key,
                                   List<Map<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.
    
    Parameters:
    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 Map<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.
    - 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
    Returns:
    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(Map<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.
    - 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
    Parameters:
    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(Map<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.
    - 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
    Parameters:
    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 updated object so that method calls can be chained together.
  - addUnprocessedKeysEntry
```
public BatchGetItemResult addUnprocessedKeysEntry(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.
    - 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
    Parameters:
    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 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.
    Returns:
    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(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.
    Parameters:
    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.
    Parameters:
    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 updated object so that method calls can be chained together.
  - withConsumedCapacity
```
public BatchGetItemResult withConsumedCapacity(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.
    Parameters:
    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 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

Did this page help you?

Class BatchGetItemResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchGetItemResult

Method Detail

getResponses

setResponses

withResponses

addResponsesEntry

clearResponsesEntries

getUnprocessedKeys

setUnprocessedKeys

withUnprocessedKeys

addUnprocessedKeysEntry

clearUnprocessedKeysEntries

getConsumedCapacity

setConsumedCapacity

withConsumedCapacity

withConsumedCapacity

toString

hashCode

equals