BatchGetItemResult (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class BatchGetItemResult
extends Object
implements Serializable, Cloneable
```
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)`
`BatchGetItemResult`	`addUnprocessedKeysEntry(String key, KeysAndAttributes value)`
`BatchGetItemResult`	`clearResponsesEntries()` Removes all the entries added into Responses.
`BatchGetItemResult`	`clearUnprocessedKeysEntries()` Removes all the entries added into UnprocessedKeys.
`BatchGetItemResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<ConsumedCapacity>`	`getConsumedCapacity()` The read 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 read 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 read capacity units consumed by the operation.
`BatchGetItemResult`	`withConsumedCapacity(ConsumedCapacity... consumedCapacity)` The read 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.
    
    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:
    Returns a reference to this object so that method calls can be chained together.
  - addResponsesEntry
```
public BatchGetItemResult addResponsesEntry(String key,
                                   List<Map<String,AttributeValue>> value)
```
  - clearResponsesEntries
```
public BatchGetItemResult clearResponsesEntries()
```
    Removes all the entries added into Responses. <p> 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 requested 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.
    If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
    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 requested 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.
    
    If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
  - 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 requested 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.
    If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
    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 requested 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.
    
    If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
  - 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 requested 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.
    If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
    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 requested 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.
    
    If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - addUnprocessedKeysEntry
```
public BatchGetItemResult addUnprocessedKeysEntry(String key,
                                         KeysAndAttributes value)
```
  - clearUnprocessedKeysEntries
```
public BatchGetItemResult clearUnprocessedKeysEntries()
```
    Removes all the entries added into UnprocessedKeys. <p> Returns a reference to this object so that method calls can be chained together.
  - getConsumedCapacity
```
public List<ConsumedCapacity> getConsumedCapacity()
```
    The read 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 read 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 read 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 read 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 read capacity units consumed by the operation.
    
    Each element consists of:
    - TableName - The table that consumed the provisioned throughput.
    - CapacityUnits - The total number of capacity units consumed.
    NOTE: This method appends the values to the existing list (if any). Use setConsumedCapacity(java.util.Collection) or withConsumedCapacity(java.util.Collection) if you want to override the existing values.
    Parameters:
    consumedCapacity - The read 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:
    Returns a reference to this object so that method calls can be chained together.
  - withConsumedCapacity
```
public BatchGetItemResult withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)
```
    The read 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 read 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:
    Returns a reference to this 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BatchGetItemResult clone()
```
    Overrides:
    
    clone 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

equals

hashCode

clone