Class AsyncBatchWriteBuilder<T>

java.lang.Object

dev.hogwai.dynamodb.simplified.builder.base.AbstractBatchWriteBuilder<T, AsyncBatchWriteBuilder<T>>

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

Type Parameters:

T - the item type

public class AsyncBatchWriteBuilder<T>
extends AbstractBatchWriteBuilder<T, AsyncBatchWriteBuilder<T>>

Builds an async batch write operation to put and delete multiple items in a single table.

Obtain via AsyncTable.batchWrite(). Executes using the async enhanced client and returns a CompletableFuture that completes with the batch write result.

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).

Field Summary

Fields inherited from class AbstractBatchWriteBuilder

itemsToPut, keysToDelete, returnConsumedCapacity

Method Summary

Modifier and Type	Method	Description
@NonNull CompletableFuture<BatchWriteResult>	execute()	Executes the batch write operation asynchronously.
protected AsyncBatchWriteBuilder<T>	self()	Returns this typed as S for fluent chaining.
protected @NonNull String	tableName()	Returns the DynamoDB table name.
protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<T>	tableSchema()	Returns the table schema for converting items to attribute maps.

Methods inherited from class AbstractBatchWriteBuilder

buildRequestItems, delete, delete, put, returnConsumedCapacity

Methods inherited from class Object

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

Method Details

self

protected AsyncBatchWriteBuilder<T> self()

Description copied from class: AbstractBatchWriteBuilder

Returns this typed as S for fluent chaining.

Specified by:

self in class AbstractBatchWriteBuilder<T, AsyncBatchWriteBuilder<T>>

Returns:

this builder

tableSchema

protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<T> tableSchema()

Description copied from class: AbstractBatchWriteBuilder

Returns the table schema for converting items to attribute maps.

Specified by:

tableSchema in class AbstractBatchWriteBuilder<T, AsyncBatchWriteBuilder<T>>

Returns:

the table schema

tableName

protected @NonNull String tableName()

Description copied from class: AbstractBatchWriteBuilder

Returns the DynamoDB table name.

Specified by:

tableName in class AbstractBatchWriteBuilder<T, AsyncBatchWriteBuilder<T>>

Returns:

the DynamoDB table name

execute

public @NonNull CompletableFuture<BatchWriteResult> execute()

Executes the batch write operation asynchronously.

All puts and deletes added to this builder 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 BatchWriteResult

Throws:

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