Package software.amazon.awssdk.services.dynamodb.model

Class BatchGetItemResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

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

All Implemented Interfaces:

ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>

@Generated("software.amazon.awssdk:codegen")
public class BatchGetItemResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>

Represents the output of a BatchGetItem operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchGetItemResponse.Builder

Method Summary

Modifier and Type	Method	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()	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.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

responses

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.

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.

unprocessedKeys

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.

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.

consumedCapacity

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.

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()

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 interface ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>

Returns:

a builder for type T

builder

public static BatchGetItemResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object