Class BatchGetItemResult
- All Implemented Interfaces:
Serializable
,Cloneable
Represents the output of a BatchGetItem operation.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddResponsesEntry
(String key, List<Map<String, AttributeValue>> value) addUnprocessedKeysEntry
(String key, KeysAndAttributes value) Removes all the entries added into Responses.Removes all the entries added into UnprocessedKeys.clone()
boolean
The read capacity units consumed by the operation.A map of table name to a list of items.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.toString()
Returns a string representation of this object; useful for testing and debugging.withConsumedCapacity
(ConsumedCapacity... consumedCapacity) The read capacity units consumed by the operation.withConsumedCapacity
(Collection<ConsumedCapacity> consumedCapacity) The read capacity units consumed by the operation.withResponses
(Map<String, List<Map<String, AttributeValue>>> responses) A map of table name to a list of items.withUnprocessedKeys
(Map<String, KeysAndAttributes> unprocessedKeys) A map of tables and their respective keys that were not processed with the current response.
-
Constructor Details
-
BatchGetItemResult
public BatchGetItemResult()
-
-
Method Details
-
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
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
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
-
clearResponsesEntries
Removes all the entries added into Responses. <p> Returns a reference to this object so that method calls can be chained together. -
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
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
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
-
clearUnprocessedKeysEntries
Removes all the entries added into UnprocessedKeys. <p> Returns a reference to this object so that method calls can be chained together. -
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
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
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)
orwithConsumedCapacity(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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-