Interface MappedTableResource<T>
- Type Parameters:
T
- The type of the modelled object.
- All Known Subinterfaces:
DynamoDbAsyncTable<T>
,DynamoDbTable<T>
- All Known Implementing Classes:
DefaultDynamoDbAsyncTable
,DefaultDynamoDbTable
Interface for a resource object that is part of either a
DynamoDbTable
or DynamoDbAsyncTable
. 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 TypeMethodDescriptionCreates aKey
object from a modelled item.Gets theDynamoDbEnhancedClientExtension
associated with this mapped resource.Gets the physical table name that operations performed by this object will be executed against.Gets theTableSchema
object that this mapped table was built with.
-
Method Details
-
mapperExtension
DynamoDbEnhancedClientExtension mapperExtension()Gets theDynamoDbEnhancedClientExtension
associated with this mapped resource.- Returns:
- The
DynamoDbEnhancedClientExtension
associated with this mapped resource.
-
tableSchema
TableSchema<T> tableSchema()Gets theTableSchema
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
Creates aKey
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.
-