Class BatchGetItemResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<BatchGetItemResponse.Builder,
BatchGetItemResponse>
Represents the output of a BatchGetItem
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BatchGetItemResponse.Builder
builder()
final List
<ConsumedCapacity> The read capacity units consumed by the entireBatchGetItem
operation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ConsumedCapacity property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Responses property.final boolean
For responses, this returns true if the service returned a value for the UnprocessedKeys property.A map of table name or table ARN to a list of items.static Class
<? extends BatchGetItemResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Map
<String, KeysAndAttributes> A map of tables and their respective keys that were not processed with the current response.Methods inherited from class software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasResponses
public final boolean hasResponses()For responses, this returns true if the service returned a value for the Responses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.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.- Returns:
- 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.
-
hasUnprocessedKeys
public final boolean hasUnprocessedKeys()For responses, this returns true if the service returned a value for the UnprocessedKeys property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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 asRequestItems
, so the value can be provided directly to a subsequentBatchGetItem
operation. For more information, seeRequestItems
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 totrue
, 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.- Returns:
- A map of tables and their respective keys that were not processed with the current response. The
UnprocessedKeys
value is in the same form asRequestItems
, so the value can be provided directly to a subsequentBatchGetItem
operation. For more information, seeRequestItems
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 totrue
, 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. -
-
-
hasConsumedCapacity
public final boolean hasConsumedCapacity()For responses, this returns true if the service returned a value for the ConsumedCapacity property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- 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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BatchGetItemResponse.Builder,
BatchGetItemResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-