@Generated(value="software.amazon.awssdk:codegen") public final class BatchGetItemResponse extends DynamoDbResponse implements 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
int |
hashCode() |
Map<String,List<Map<String,AttributeValue>>> |
responses()
A map of table name to a list of items.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends BatchGetItemResponse.Builder> |
serializableBuilderClass() |
BatchGetItemResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Map<String,KeysAndAttributes> |
unprocessedKeys()
A map of tables and their respective keys that were not processed with the current response.
|
responseMetadatasdkHttpResponsecopypublic 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>toBuilder in class AwsResponsepublic static BatchGetItemResponse.Builder builder()
public static Class<? extends BatchGetItemResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will
again be available.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.