Class AsyncBatchGetBuilder<T>

java.lang.Object

dev.hogwai.dynamodb.simplified.builder.base.AbstractBatchGetBuilder<T, AsyncBatchGetBuilder<T>>

dev.hogwai.dynamodb.simplified.async.AsyncBatchGetBuilder<T>

Type Parameters:

T - the item type

public class AsyncBatchGetBuilder<T>
extends AbstractBatchGetBuilder<T, AsyncBatchGetBuilder<T>>

Builds an async batch get operation to retrieve multiple items from a single table by their keys.

Obtain via AsyncTable.batchGet(). The default execute() path uses the async enhanced client and completes after its pages have been collected; projection execution uses the low-level client and executeWithPagination() returns one page.

Field Summary

Fields inherited from class AbstractBatchGetBuilder

consistentRead, keys, projectionExpression, returnConsumedCapacity

Method Summary

Modifier and Type	Method	Description
@NonNull CompletableFuture<BatchGetResult<T>>	execute()	Executes the batch get operation asynchronously and returns all matching items aggregated from all pages.
@NonNull CompletableFuture<PagedResult<T>>	executeWithPagination()	Executes the batch get operation and returns only the first page of results.
protected AsyncBatchGetBuilder<T>	self()	Returns this typed as S for fluent chaining.
protected @NonNull String	tableName()	Returns the DynamoDB table name.

Methods inherited from class AbstractBatchGetBuilder

addKey, addKey, addKeys, buildKeysAndAttributes, consistentRead, keys, project, project, returnConsumedCapacity

Methods inherited from class Object

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

Method Details

self

protected AsyncBatchGetBuilder<T> self()

Description copied from class: AbstractBatchGetBuilder

Returns this typed as S for fluent chaining.

Specified by:

self in class AbstractBatchGetBuilder<T, AsyncBatchGetBuilder<T>>

Returns:

this builder

tableName

protected @NonNull String tableName()

Description copied from class: AbstractBatchGetBuilder

Returns the DynamoDB table name.

Specified by:

tableName in class AbstractBatchGetBuilder<T, AsyncBatchGetBuilder<T>>

Returns:

the DynamoDB table name

execute

public @NonNull CompletableFuture<BatchGetResult<T>> execute()

Executes the batch get operation asynchronously and returns all matching items aggregated from all pages.

Returns:

a CompletableFuture containing the BatchGetResult

Throws:

IllegalArgumentException - if more than 100 keys are provided

executeWithPagination

public @NonNull CompletableFuture<PagedResult<T>> executeWithPagination()

Executes the batch get operation and returns only the first page of results.

Since batch get does not use traditional cursor-based pagination, the last evaluated key is always null. Unprocessed keys are not exposed by the returned PagedResult; use execute() to access them.

Returns:

a CompletableFuture containing a PagedResult with items from the first response page

Throws:

IllegalStateException - if a projection is configured; use execute() instead