software.amazon.awssdk.services.dynamodb.model

Class BatchGetItemResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse

software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchGetItemResponse
extends DynamoDbResponse
implements ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>

Represents the output of a BatchGetItem operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchGetItemResponse.Builder

Method Summary

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() Returns true if the ConsumedCapacity property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasResponses() Returns true if the Responses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUnprocessedKeys() Returns true if the UnprocessedKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.

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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasResponses

public final boolean hasResponses()

Returns true if the Responses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

responses

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.

You can use hasResponses() to see if a value was sent in this field.

Returns:

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.

hasUnprocessedKeys

public final boolean hasUnprocessedKeys()

Returns true if the UnprocessedKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

unprocessedKeys

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.

You can use hasUnprocessedKeys() to see if a value was sent in this field.

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 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.

hasConsumedCapacity

public final boolean hasConsumedCapacity()

Returns true if the ConsumedCapacity property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

consumedCapacity

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.

You can use hasConsumedCapacity() to see if a value was sent in this field.

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

public BatchGetItemResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static BatchGetItemResponse.Builder builder()

serializableBuilderClass

public static Class<? extends BatchGetItemResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo