software.amazon.awssdk.enhanced.dynamodb.model

Interface ReadBatch.Builder<T>

Type Parameters:

T - the type that items in this table map to

Enclosing class:

ReadBatch

@NotThreadSafe
public static interface ReadBatch.Builder<T>

A builder that is used to create a request with the desired parameters.

A valid builder must define a MappedTableResource and add at least one GetItemEnhancedRequest.

Method Summary

Modifier and Type	Method and Description
ReadBatch.Builder<T>	addGetItem(Consumer<GetItemEnhancedRequest.Builder> requestConsumer) Adds a GetItemEnhancedRequest with a primary Key to the builder by accepting a consumer of GetItemEnhancedRequest.Builder.
ReadBatch.Builder<T>	addGetItem(GetItemEnhancedRequest request) Adds a GetItemEnhancedRequest with a primary Key to the builder.
ReadBatch.Builder<T>	addGetItem(Key key) Adds a GetItem request with a primary Key to the builder.
ReadBatch.Builder<T>	addGetItem(T keyItem) Adds a GetItem request to the builder.
ReadBatch	build()
ReadBatch.Builder<T>	mappedTableResource(MappedTableResource<T> mappedTableResource) Sets the mapped table resource (table) that the items in this read batch should come from.

Method Detail

mappedTableResource

ReadBatch.Builder<T> mappedTableResource(MappedTableResource<T> mappedTableResource)

Sets the mapped table resource (table) that the items in this read batch should come from.

Parameters:

mappedTableResource - the table reference

Returns:

a builder of this type

addGetItem

ReadBatch.Builder<T> addGetItem(GetItemEnhancedRequest request)

Adds a GetItemEnhancedRequest with a primary Key to the builder.

Parameters:

request - A GetItemEnhancedRequest

Returns:

a builder of this type

addGetItem

ReadBatch.Builder<T> addGetItem(Consumer<GetItemEnhancedRequest.Builder> requestConsumer)

Adds a GetItemEnhancedRequest with a primary Key to the builder by accepting a consumer of GetItemEnhancedRequest.Builder.

Parameters:

requestConsumer - a Consumer of GetItemEnhancedRequest

Returns:

a builder of this type

addGetItem

ReadBatch.Builder<T> addGetItem(Key key)

Adds a GetItem request with a primary Key to the builder.

Parameters:

key - A Key to match the record retrieved from the database.

Returns:

a builder of this type

addGetItem

ReadBatch.Builder<T> addGetItem(T keyItem)

Adds a GetItem request to the builder.

Parameters:

keyItem - an item that will have its key fields used to match a record to retrieve from the database.

Returns:

a builder of this type

build

ReadBatch build()