software.amazon.awssdk.extensions.dynamodb.mappingclient

Interface MappedTableResource<T>

Type Parameters:

T - The type of the modelled object.

All Known Subinterfaces:

AsyncMappedTable<T>, MappedTable<T>

All Known Implementing Classes:

DynamoDbAsyncMappedTable, DynamoDbMappedTable

public interface MappedTableResource<T>

Interface for a resource object that is part of either a MappedTable or AsyncMappedTable. This part of the interface is common between both of those higher order interfaces and has methods to access the metadata associated with the mapped entity, such as the schema and the table name, but knows nothing about how to actually execute operations against it.

Method Summary

Modifier and Type	Method and Description
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

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.

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.