Class BatchGetItemEnhancedRequest

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.BatchGetItemEnhancedRequest

@ThreadSafe
public final class BatchGetItemEnhancedRequest
extends Object

Defines parameters used for the batchGetItem() operation (such as DynamoDbEnhancedClient.batchGetItem(BatchGetItemEnhancedRequest)).

A request contains references to keys and tables organized into one ReadBatch object per queried table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BatchGetItemEnhancedRequest.Builder	A builder that is used to create a request with the desired parameters.

Method Summary

Modifier and Type	Method	Description
static BatchGetItemEnhancedRequest.Builder	builder()	Creates a newly initialized builder for a request object.
boolean	equals(Object o)
int	hashCode()
Collection<ReadBatch>	readBatches()	Returns the collection of ReadBatch in this request object.
ReturnConsumedCapacity	returnConsumedCapacity()	Whether to return the capacity consumed by this operation.
String	returnConsumedCapacityAsString()	Whether to return the capacity consumed by this operation.
BatchGetItemEnhancedRequest.Builder	toBuilder()	Returns a builder initialized with all existing values on the request object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static BatchGetItemEnhancedRequest.Builder builder()

Creates a newly initialized builder for a request object.

toBuilder

public BatchGetItemEnhancedRequest.Builder toBuilder()

Returns a builder initialized with all existing values on the request object.

readBatches

public Collection<ReadBatch> readBatches()

Returns the collection of ReadBatch in this request object.

returnConsumedCapacity

public ReturnConsumedCapacity returnConsumedCapacity()

Whether to return the capacity consumed by this operation.

See Also:

• GetItemRequest.returnConsumedCapacity()

returnConsumedCapacityAsString

public String returnConsumedCapacityAsString()

Whether to return the capacity consumed by this operation.

Similar to returnConsumedCapacity() but return the value as a string. This is useful in situations where the value is not defined in ReturnConsumedCapacity.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object