@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) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasConsumedCapacity()
For responses, this returns true if the service returned a value for the ConsumedCapacity property.
|
int |
hashCode() |
boolean |
hasResponses()
For responses, this returns true if the service returned a value for the Responses property.
|
boolean |
hasUnprocessedKeys()
For responses, this returns true if the service returned a value for the UnprocessedKeys property.
|
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() |
String |
toString()
Returns a string representation of this object.
|
Map<String,KeysAndAttributes> |
unprocessedKeys()
A map of tables and their respective keys that were not processed with the current response.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasResponses()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasResponses() method.
Responses consists of a table name,
along with a map of attribute data consisting of the data type and attribute value.public final boolean hasUnprocessedKeys()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasUnprocessedKeys() method.
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 final boolean hasConsumedCapacity()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasConsumedCapacity() method.
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 ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>toBuilder in class AwsResponsepublic static BatchGetItemResponse.Builder builder()
public static Class<? extends BatchGetItemResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.