software.amazon.awssdk.extensions.dynamodb.mappingclient

Interface DynamoDbAsyncIndex<T>

Type Parameters:

T - The type of the modelled object.

All Known Implementing Classes:

DefaultDynamoDbAsyncIndex

public interface DynamoDbAsyncIndex<T>

Asynchronous interface for running commands against an object that is linked to a specific DynamoDb secondary index and knows how to map records from the table that index is linked to into a modelled object.

Method Summary

Modifier and Type	Method and Description
String	indexName() Gets the physical secondary index name that operations performed by this object will be executed against.
Key	keyFrom(T item) Creates a Key object from a modelled item.
MapperExtension	mapperExtension() Gets the MapperExtension associated with this mapped resource.
default SdkPublisher<Page<T>>	query(QueryEnhancedRequest request)
default SdkPublisher<Page<T>>	scan(ScanEnhancedRequest request)
String	tableName() Gets the physical table name that operations performed by this object will be executed against.
TableSchema<T>	tableSchema() Gets the TableSchema object that this mapped table was built with.

Method Detail

query

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

scan

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

mapperExtension

MapperExtension mapperExtension()

Gets the MapperExtension associated with this mapped resource.

Returns:

The MapperExtension associated with this mapped resource.

tableSchema

TableSchema<T> tableSchema()

Gets the TableSchema object that this mapped table was built with.

Returns:

The TableSchema object for this mapped table.

tableName

String tableName()

Gets the physical table name that operations performed by this object will be executed against.

Returns:

The physical table name.

indexName

String indexName()

Gets the physical secondary index name that operations performed by this object will be executed against.

Returns:

The physical secondary index name.

keyFrom

Key keyFrom(T item)

Creates a Key object from a modelled item. This key can be used in query conditionals and get operations to locate a specific record.

Parameters:

item - The item to extract the key fields from.

Returns:

A key that has been initialized with the index values extracted from the modelled object.