@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BatchGetItemResult extends AmazonWebServiceResult<ResponseMetadata> 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)
Add a single Responses entry
|
BatchGetItemResult |
addUnprocessedKeysEntry(String key,
KeysAndAttributes value)
Add a single UnprocessedKeys entry
|
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 entire
BatchGetItem operation. |
Map<String,List<Map<String,AttributeValue>>> |
getResponses()
A map of table name or table ARN 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 entire
BatchGetItem operation. |
void |
setResponses(Map<String,List<Map<String,AttributeValue>>> responses)
A map of table name or table ARN 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.
|
BatchGetItemResult |
withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)
The read capacity units consumed by the entire
BatchGetItem operation. |
BatchGetItemResult |
withConsumedCapacity(ConsumedCapacity... consumedCapacity)
The read capacity units consumed by the entire
BatchGetItem operation. |
BatchGetItemResult |
withResponses(Map<String,List<Map<String,AttributeValue>>> responses)
A map of table name or table ARN 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.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public Map<String,List<Map<String,AttributeValue>>> getResponses()
A map of table name or table ARN to a list of items. Each object in Responses
consists of a table
name or ARN, along with a map of attribute data consisting of the data type and attribute value.
Responses
consists of a
table name or ARN, along with a map of attribute data consisting of the data type and attribute value.public void setResponses(Map<String,List<Map<String,AttributeValue>>> responses)
A map of table name or table ARN to a list of items. Each object in Responses
consists of a table
name or ARN, along with a map of attribute data consisting of the data type and attribute value.
responses
- A map of table name or table ARN to a list of items. Each object in Responses
consists of a
table name or ARN, 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)
A map of table name or table ARN to a list of items. Each object in Responses
consists of a table
name or ARN, along with a map of attribute data consisting of the data type and attribute value.
responses
- A map of table name or table ARN to a list of items. Each object in Responses
consists of a
table name or ARN, 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)
public BatchGetItemResult clearResponsesEntries()
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.
ProjectionExpression
- 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.
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.
ProjectionExpression
- 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)
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.
ProjectionExpression
- 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.
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.
ProjectionExpression
- 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)
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.
ProjectionExpression
- 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.
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.
ProjectionExpression
- 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)
public BatchGetItemResult clearUnprocessedKeysEntries()
public List<ConsumedCapacity> getConsumedCapacity()
The read capacity units consumed by the entire BatchGetItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
BatchGetItem
operation.
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)
The read capacity units consumed by the entire BatchGetItem
operation.
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 entire BatchGetItem
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)
The read capacity units consumed by the entire BatchGetItem
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.
consumedCapacity
- The read capacity units consumed by the entire BatchGetItem
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)
The read capacity units consumed by the entire BatchGetItem
operation.
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 entire BatchGetItem
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()