Class AsyncCrossTableBatchGetBuilder

java.lang.Object

dev.hogwai.dynamodb.simplified.builder.base.AbstractCrossTableBatchGetBuilder<AsyncCrossTableBatchGetBuilder>

dev.hogwai.dynamodb.simplified.async.AsyncCrossTableBatchGetBuilder

public class AsyncCrossTableBatchGetBuilder
extends AbstractCrossTableBatchGetBuilder<AsyncCrossTableBatchGetBuilder>

Builds an async cross-table batch get operation to retrieve items from multiple tables.

Obtain via AsyncDynamoSimplifiedClient.batchGet(). Uses the low-level DynamoDbAsyncClient.batchGetItem(BatchGetItemRequest) which returns a CompletableFuture, avoiding the reactive publisher model.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractCrossTableBatchGetBuilder

AbstractCrossTableBatchGetBuilder.Entry

Field Summary

Fields inherited from class AbstractCrossTableBatchGetBuilder

consistentRead, entries, returnConsumedCapacity

Constructor Summary

Constructors

Constructor	Description
AsyncCrossTableBatchGetBuilder(@NonNull software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient)	Constructs a new AsyncCrossTableBatchGetBuilder.

Method Summary

Modifier and Type	Method	Description
<T> @NonNull AsyncCrossTableBatchGetBuilder	addKey(@NonNull AsyncTable<T> table, @NonNull Object partitionKey)	Adds a key to retrieve by partition key from the given async table.
<T> @NonNull AsyncCrossTableBatchGetBuilder	addKey(@NonNull AsyncTable<T> table, @NonNull Object partitionKey, @NonNull Object sortKey)	Adds a key to retrieve by partition and sort key from the given async table.
<T> @NonNull AsyncCrossTableBatchGetBuilder	addKeys(@NonNull AsyncTable<T> table, @NonNull Collection<?> partitionKeys)	Adds multiple partition keys from the given async table at once.
@NonNull CompletableFuture<CrossTableBatchGetResult>	execute()	Executes the batch get operation asynchronously.
protected @NonNull String	getTableName(@NonNull AbstractCrossTableBatchGetBuilder.Entry entry)	Extracts the DynamoDB table name from an entry's table reference.
protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<?>	getTableSchema(@NonNull AbstractCrossTableBatchGetBuilder.Entry entry)	Extracts the table schema from an entry's table reference.
protected @NonNull AsyncCrossTableBatchGetBuilder	self()	Returns this typed as S for fluent chaining.

Methods inherited from class AbstractCrossTableBatchGetBuilder

buildKey, buildRequestItems, consistentRead, groupEntriesByTable, project, project, returnConsumedCapacity

Methods inherited from class Object

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

Constructor Details

AsyncCrossTableBatchGetBuilder

public AsyncCrossTableBatchGetBuilder(@NonNull software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient)

Constructs a new AsyncCrossTableBatchGetBuilder.

Parameters:

dynamoDbAsyncClient - the low-level async DynamoDB client

Method Details

self

protected @NonNull AsyncCrossTableBatchGetBuilder self()

Description copied from class: AbstractCrossTableBatchGetBuilder

Returns this typed as S for fluent chaining.

Specified by:

self in class AbstractCrossTableBatchGetBuilder<AsyncCrossTableBatchGetBuilder>

Returns:

this builder

getTableName

protected @NonNull String getTableName(@NonNull AbstractCrossTableBatchGetBuilder.Entry entry)

Description copied from class: AbstractCrossTableBatchGetBuilder

Extracts the DynamoDB table name from an entry's table reference.

Specified by:

getTableName in class AbstractCrossTableBatchGetBuilder<AsyncCrossTableBatchGetBuilder>

Parameters:

entry - the entry whose table name to extract

Returns:

the DynamoDB table name

getTableSchema

protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<?> getTableSchema(@NonNull AbstractCrossTableBatchGetBuilder.Entry entry)

Description copied from class: AbstractCrossTableBatchGetBuilder

Extracts the table schema from an entry's table reference.

Specified by:

getTableSchema in class AbstractCrossTableBatchGetBuilder<AsyncCrossTableBatchGetBuilder>

Parameters:

entry - the entry whose table schema to extract

Returns:

the table schema

addKey

public <T> @NonNull AsyncCrossTableBatchGetBuilder addKey(@NonNull AsyncTable<T> table,
 @NonNull Object partitionKey)

Adds a key to retrieve by partition key from the given async table.

Type Parameters:

T - the item type

Parameters:

table - the typed async table to read from

partitionKey - the partition key value

Returns:

this builder

addKey

public <T> @NonNull AsyncCrossTableBatchGetBuilder addKey(@NonNull AsyncTable<T> table,
 @NonNull Object partitionKey,
 @NonNull Object sortKey)

Adds a key to retrieve by partition and sort key from the given async table.

Type Parameters:

T - the item type

Parameters:

table - the typed async table to read from

partitionKey - the partition key value

sortKey - the sort key value

Returns:

this builder

addKeys

public <T> @NonNull AsyncCrossTableBatchGetBuilder addKeys(@NonNull AsyncTable<T> table,
 @NonNull Collection<?> partitionKeys)

Adds multiple partition keys from the given async table at once.

Type Parameters:

T - the item type

Parameters:

table - the typed async table to read from

partitionKeys - the partition key values

Returns:

this builder

execute

public @NonNull CompletableFuture<CrossTableBatchGetResult> execute()

Executes the batch get operation asynchronously.

Groups entries by table name and calls the low-level DynamoDB API.

Returns:

a CompletableFuture containing the CrossTableBatchGetResult

Throws:

IllegalArgumentException - if more than 100 keys are provided