software.amazon.awssdk.extensions.dynamodb.mappingclient

Interface MappedIndex<T>

Type Parameters:

T - The type of the modelled object.

All Known Implementing Classes:

DynamoDbMappedIndex

public interface MappedIndex<T>

Synchronous 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
<R> R	execute(IndexOperation<T,?,?,R> operationToPerform) Executes a command that is expected to return a single data item against the database with the context of the specific table and secondary index this object is linked to.
<R> SdkIterable<R>	execute(PaginatedIndexOperation<T,?,?,R> operationToPerform) Executes a command that is expected to return a paginated list of data items against the database with the context of the specific table and secondary index this object is linked to.
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.
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

execute

<R> R execute(IndexOperation<T,?,?,R> operationToPerform)

Executes a command that is expected to return a single data item against the database with the context of the specific table and secondary index this object is linked to.

Type Parameters:

R - The expected return type from the operation. This is typically inferred by the compiler.

Parameters:

operationToPerform - The operation to be performed in the context of the secondary index.

Returns:

the result of the operation being executed. The documentation on the operation itself should have more information.

execute

<R> SdkIterable<R> execute(PaginatedIndexOperation<T,?,?,R> operationToPerform)

Executes a command that is expected to return a paginated list of data items against the database with the context of the specific table and secondary index this object is linked to.

Type Parameters:

R - The expected return type from the operation. This is typically inferred by the compiler.

Parameters:

operationToPerform - The operation to be performed in the context of the secondary index.

Returns:

An SdkIterable that will return successive pages of result data items as it is iterated over.

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.