public class BatchGetItemResult extends Object implements Serializable, Cloneable
Represents the output of a BatchGetItem operation.
Constructor and Description |
---|
BatchGetItemResult() |
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.
|
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.
|
public Map<String,List<Map<String,AttributeValue>>> getResponses()
public void setResponses(Map<String,List<Map<String,AttributeValue>>> responses)
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.public BatchGetItemResult withResponses(Map<String,List<Map<String,AttributeValue>>> responses)
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.public BatchGetItemResult addResponsesEntry(String key, List<Map<String,AttributeValue>> 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.public BatchGetItemResult clearResponsesEntries()
Returns a reference to this object so that method calls can be chained together.
public Map<String,KeysAndAttributes> getUnprocessedKeys()
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.
Constraints:
Length: 1 - 100
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.
public void setUnprocessedKeys(Map<String,KeysAndAttributes> unprocessedKeys)
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.
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 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.
public BatchGetItemResult withUnprocessedKeys(Map<String,KeysAndAttributes> unprocessedKeys)
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 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 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.
public BatchGetItemResult addUnprocessedKeysEntry(String key, KeysAndAttributes value)
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.
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.public BatchGetItemResult clearUnprocessedKeysEntries()
Returns a reference to this object so that method calls can be chained together.
public List<ConsumedCapacity> getConsumedCapacity()
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
public void setConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
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.
public BatchGetItemResult withConsumedCapacity(ConsumedCapacity... consumedCapacity)
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.
Returns a reference to this object so that method calls can be chained together.
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.
public BatchGetItemResult withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)
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 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.
public String toString()
toString
in class Object
Object.toString()
public BatchGetItemResult clone()
Copyright © 2015. All rights reserved.