Class BatchGetBuilder<T>

java.lang.Object

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

dev.hogwai.dynamodb.simplified.builder.BatchGetBuilder<T>

Type Parameters:

T - the item type

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

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

Obtain via Table.batchGet().

Field Summary

Fields inherited from class AbstractBatchGetBuilder

consistentRead, keys, projectionExpression, returnConsumedCapacity

Constructor Summary

Constructors

Constructor	Description
BatchGetBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClient enhancedClient, @NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table, @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient)	Constructs a batch get builder for the given table.

Method Summary

Modifier and Type	Method	Description
@NonNull BatchGetResult<T>	execute()	Executes the batch get operation and returns all matching items along with any unprocessed keys.
protected BatchGetBuilder<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

Constructor Details

BatchGetBuilder

public BatchGetBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClient enhancedClient,
 @NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table,
 @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient)

Constructs a batch get builder for the given table.

Typically obtained via Table.batchGet().

Parameters:

enhancedClient - the enhanced DynamoDB client

table - the typed DynamoDB table

dynamoDbClient - the low-level DynamoDB client (used for projection fallback)

Method Details

self

protected BatchGetBuilder<T> self()

Description copied from class: AbstractBatchGetBuilder

Returns this typed as S for fluent chaining.

Specified by:

self in class AbstractBatchGetBuilder<T, BatchGetBuilder<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, BatchGetBuilder<T>>

Returns:

the DynamoDB table name

execute

public @NonNull BatchGetResult<T> execute()

Executes the batch get operation and returns all matching items along with any unprocessed keys.

If a projection was set via AbstractBatchGetBuilder.project(String...), the operation falls back to the low-level DynamoDB API to support attribute filtering.

Returns:

a BatchGetResult containing the retrieved items and unprocessed keys

Throws:

IllegalArgumentException - if more than 100 keys are provided