Class AsyncCrossTableBatchWriteBuilder

java.lang.Object

dev.hogwai.dynamodb.simplified.builder.base.AbstractCrossTableBatchWriteBuilder<AsyncCrossTableBatchWriteBuilder>

dev.hogwai.dynamodb.simplified.async.AsyncCrossTableBatchWriteBuilder

public class AsyncCrossTableBatchWriteBuilder
extends AbstractCrossTableBatchWriteBuilder<AsyncCrossTableBatchWriteBuilder>

Builds an async cross-table batch write operation to put and delete items across multiple tables.

Obtain via AsyncDynamoSimplifiedClient.batchWrite(). A single batch write can contain up to 25 put and delete operations combined. Unprocessed items are automatically retried with exponential backoff (up to 3 retries).

Nested Class Summary

Nested classes/interfaces inherited from class AbstractCrossTableBatchWriteBuilder

AbstractCrossTableBatchWriteBuilder.Operation

Field Summary

Fields inherited from class AbstractCrossTableBatchWriteBuilder

operations, returnConsumedCapacity

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NonNull CompletableFuture<CrossTableBatchWriteResult>	execute()	Executes the batch write operation asynchronously.
protected @NonNull String	getTableName(@NonNull AbstractCrossTableBatchWriteBuilder.Operation operation)	Extracts the DynamoDB table name from an operation's table reference.
protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<?>	getTableSchema(@NonNull AbstractCrossTableBatchWriteBuilder.Operation operation)	Extracts the table schema from an operation's table reference.
protected @NonNull AsyncCrossTableBatchWriteBuilder	self()	Returns this typed as S for fluent chaining.

Methods inherited from class AbstractCrossTableBatchWriteBuilder

buildKey, buildRequestItems, delete, delete, put, returnConsumedCapacity

Methods inherited from class Object

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

Constructor Details

AsyncCrossTableBatchWriteBuilder

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

Constructs a new AsyncCrossTableBatchWriteBuilder.

Parameters:

dynamoDbAsyncClient - the low-level async DynamoDB client

Method Details

self

protected @NonNull AsyncCrossTableBatchWriteBuilder self()

Description copied from class: AbstractCrossTableBatchWriteBuilder

Returns this typed as S for fluent chaining.

Specified by:

self in class AbstractCrossTableBatchWriteBuilder<AsyncCrossTableBatchWriteBuilder>

Returns:

this builder

getTableName

protected @NonNull String getTableName(@NonNull AbstractCrossTableBatchWriteBuilder.Operation operation)

Description copied from class: AbstractCrossTableBatchWriteBuilder

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

Specified by:

getTableName in class AbstractCrossTableBatchWriteBuilder<AsyncCrossTableBatchWriteBuilder>

Parameters:

operation - the operation whose table name to extract

Returns:

the DynamoDB table name

getTableSchema

protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<?> getTableSchema(@NonNull AbstractCrossTableBatchWriteBuilder.Operation operation)

Description copied from class: AbstractCrossTableBatchWriteBuilder

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

Specified by:

getTableSchema in class AbstractCrossTableBatchWriteBuilder<AsyncCrossTableBatchWriteBuilder>

Parameters:

operation - the operation whose table schema to extract

Returns:

the table schema

execute

public @NonNull CompletableFuture<CrossTableBatchWriteResult> execute()

Executes the batch write operation asynchronously.

All puts and deletes are sent in a single batch write request. Unprocessed items are automatically retried with exponential backoff (up to 3 retries).

Returns:

a CompletableFuture containing the CrossTableBatchWriteResult

Throws:

IllegalArgumentException - if more than 25 items (puts + deletes combined) are provided