software.amazon.awssdk.enhanced.dynamodb

Interface DynamoDbTable<T>

Type Parameters:

T - The type of the modelled object.

All Superinterfaces:

MappedTableResource<T>

All Known Implementing Classes:

DefaultDynamoDbTable

public interface DynamoDbTable<T>
extends MappedTableResource<T>

Synchronous interface for running commands against an object that is linked to a specific DynamoDb table resource and therefore knows how to map records from that table into a modelled object.

Method Summary

Modifier and Type	Method and Description
default Void	createTable()
default Void	createTable(Consumer<CreateTableEnhancedRequest.Builder> requestConsumer)
default Void	createTable(CreateTableEnhancedRequest request)
default T	deleteItem(Consumer<DeleteItemEnhancedRequest.Builder> requestConsumer)
default T	deleteItem(DeleteItemEnhancedRequest request)
default T	getItem(Consumer<GetItemEnhancedRequest.Builder> requestConsumer)
default T	getItem(GetItemEnhancedRequest request)
DynamoDbIndex<T>	index(String indexName) Returns a mapped index that can be used to execute commands against a secondary index belonging to the table being mapped by this object.
default Void	putItem(Class<? extends T> itemClass, Consumer<PutItemEnhancedRequest.Builder<T>> requestConsumer)
default Void	putItem(PutItemEnhancedRequest<T> request)
default SdkIterable<Page<T>>	query(Consumer<QueryEnhancedRequest.Builder> requestConsumer)
default SdkIterable<Page<T>>	query(QueryEnhancedRequest request)
default SdkIterable<Page<T>>	scan()
default SdkIterable<Page<T>>	scan(Consumer<ScanEnhancedRequest.Builder> requestConsumer)
default SdkIterable<Page<T>>	scan(ScanEnhancedRequest request)
default T	updateItem(Class<? extends T> itemClass, Consumer<UpdateItemEnhancedRequest.Builder<T>> requestConsumer)
default T	updateItem(UpdateItemEnhancedRequest<T> request)

Methods inherited from interface software.amazon.awssdk.enhanced.dynamodb.MappedTableResource

keyFrom, mapperExtension, tableName, tableSchema

Method Detail

index

DynamoDbIndex<T> index(String indexName)

Returns a mapped index that can be used to execute commands against a secondary index belonging to the table being mapped by this object. Note that only a subset of the commands that work against a table will work against a secondary index.

Parameters:

indexName - The name of the secondary index to build the command interface for.

Returns:

A DynamoDbIndex object that can be used to execute database commands against.

createTable

default Void createTable(CreateTableEnhancedRequest request)

createTable

default Void createTable(Consumer<CreateTableEnhancedRequest.Builder> requestConsumer)

createTable

default Void createTable()

deleteItem

default T deleteItem(DeleteItemEnhancedRequest request)

deleteItem

default T deleteItem(Consumer<DeleteItemEnhancedRequest.Builder> requestConsumer)

getItem

default T getItem(GetItemEnhancedRequest request)

getItem

default T getItem(Consumer<GetItemEnhancedRequest.Builder> requestConsumer)

query

default SdkIterable<Page<T>> query(QueryEnhancedRequest request)

query

default SdkIterable<Page<T>> query(Consumer<QueryEnhancedRequest.Builder> requestConsumer)

putItem

default Void putItem(PutItemEnhancedRequest<T> request)

putItem

default Void putItem(Class<? extends T> itemClass,
                     Consumer<PutItemEnhancedRequest.Builder<T>> requestConsumer)

scan

default SdkIterable<Page<T>> scan(ScanEnhancedRequest request)

scan

default SdkIterable<Page<T>> scan(Consumer<ScanEnhancedRequest.Builder> requestConsumer)

scan

default SdkIterable<Page<T>> scan()

updateItem

default T updateItem(UpdateItemEnhancedRequest<T> request)

updateItem

default T updateItem(Class<? extends T> itemClass,
                     Consumer<UpdateItemEnhancedRequest.Builder<T>> requestConsumer)