Class BatchGetItemEnhancedRequest.Builder

java.lang.Object

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

Enclosing class:

BatchGetItemEnhancedRequest

@NotThreadSafe
public static final class BatchGetItemEnhancedRequest.Builder
extends Object

A builder that is used to create a request with the desired parameters.

Method Summary

Modifier and Type	Method	Description
BatchGetItemEnhancedRequest.Builder	addReadBatch(ReadBatch readBatch)	Adds a read batch to the collection of batches on this builder.
BatchGetItemEnhancedRequest	build()
BatchGetItemEnhancedRequest.Builder	readBatches(Collection<ReadBatch> readBatches)	Sets a collection of read batches to use in the batchGetItem operation.
BatchGetItemEnhancedRequest.Builder	readBatches(ReadBatch... readBatches)	Sets one or more read batches to use in the batchGetItem operation.
BatchGetItemEnhancedRequest.Builder	returnConsumedCapacity(String returnConsumedCapacity)	Whether to return the capacity consumed by this operation.
BatchGetItemEnhancedRequest.Builder	returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)	Whether to return the capacity consumed by this operation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

readBatches

public BatchGetItemEnhancedRequest.Builder readBatches(Collection<ReadBatch> readBatches)

Sets a collection of read batches to use in the batchGetItem operation.

Parameters:

readBatches - the collection of read batches

Returns:

a builder of this type

readBatches

public BatchGetItemEnhancedRequest.Builder readBatches(ReadBatch... readBatches)

Sets one or more read batches to use in the batchGetItem operation.

Parameters:

readBatches - one or more ReadBatch, separated by comma.

Returns:

a builder of this type

addReadBatch

public BatchGetItemEnhancedRequest.Builder addReadBatch(ReadBatch readBatch)

Adds a read batch to the collection of batches on this builder. If this is the first batch, the method creates a new list.

Parameters:

readBatch - a single read batch

Returns:

a builder of this type

returnConsumedCapacity

public BatchGetItemEnhancedRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Whether to return the capacity consumed by this operation.

Returns:

a builder of this type

See Also:

• BatchGetItemRequest.Builder.returnConsumedCapacity(ReturnConsumedCapacity)

returnConsumedCapacity

public BatchGetItemEnhancedRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)

Whether to return the capacity consumed by this operation.

Returns:

a builder of this type

See Also:

• BatchGetItemRequest.Builder.returnConsumedCapacity(String)

build

public BatchGetItemEnhancedRequest build()