@Generated(value="software.amazon.awssdk:codegen") public class BatchGetItemResponse extends AmazonWebServiceResult<ResponseMetadata> implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>
Represents the output of a BatchGetItem
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
BatchGetItemResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static BatchGetItemResponse.Builder |
builder() |
List<ConsumedCapacity> |
consumedCapacity()
The read capacity units consumed by the entire
BatchGetItem operation. |
boolean |
equals(Object obj) |
int |
hashCode() |
Map<String,List<Map<String,AttributeValue>>> |
responses()
A map of table name to a list of items.
|
static Class<? extends BatchGetItemResponse.Builder> |
serializableBuilderClass() |
BatchGetItemResponse.Builder |
toBuilder() |
String |
toString() |
Map<String,KeysAndAttributes> |
unprocessedKeys()
A map of tables and their respective keys that were not processed with the current response.
|
setSdkHttpMetadata, setSdkResponseMetadata
public 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.
Responses
consists of a table name,
along with a map of attribute data consisting of the data type and attribute value.public 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
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 List<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.
BatchGetItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.
CapacityUnits
- The total number of capacity units consumed.
public BatchGetItemResponse.Builder toBuilder()
toBuilder
in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>
public static BatchGetItemResponse.Builder builder()
public static Class<? extends BatchGetItemResponse.Builder> serializableBuilderClass()
Copyright © 2017. All rights reserved.