software.amazon.awssdk.extensions.dynamodb.mappingclient.staticmapper

Class StaticTableMetadata

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.staticmapper.StaticTableMetadata

All Implemented Interfaces:

TableMetadata

@ThreadSafe
public class StaticTableMetadata
extends Object
implements TableMetadata

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Collection<String>	getAllKeys() Returns all the names of attributes associated with any index (primary or secondary) known for this table.
<T> Optional<T>	getCustomMetadataObject(String key, Class<? extends T> objectClass) Returns a custom metadata object.
Collection<String>	getIndexKeys(String indexName) Returns all the names of attributes associated with the keys of a specified index.
String	getIndexPartitionKey(String indexName) Returns the attribute name of the partition key for an index.
Optional<String>	getIndexSortKey(String indexName) Returns the attribute name of the sort key for an index.
Optional<ScalarAttributeType>	getScalarAttributeType(String keyAttribute) Returns the DynamoDb scalar attribute type associated with a key attribute if one is applicable.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.extensions.dynamodb.mappingclient.TableMetadata

getPrimaryIndexName, getPrimaryKeys, getPrimaryPartitionKey, getPrimarySortKey

Method Detail

getCustomMetadataObject

public <T> Optional<T> getCustomMetadataObject(String key,
                                               Class<? extends T> objectClass)

Description copied from interface: TableMetadata

Returns a custom metadata object. These objects are used by extensions to the library, therefore the type of object stored is flexible and does not need to be known by the interface.

Specified by:

getCustomMetadataObject in interface TableMetadata

Type Parameters:

T - The flexible type for the object being returned. The compiler will typically infer this.

Parameters:

key - A unique key for the metadata object. This namespace is shared by all extensions, so it is recommended best practice to qualify it with the name of your extension.

objectClass - The java class that the object will be cast to before returning. An exception will be thrown if the stored object cannot be cast to this class.

Returns:

An optional containing custom metadata object or empty if the object was not found.

getIndexPartitionKey

public String getIndexPartitionKey(String indexName)

Description copied from interface: TableMetadata

Returns the attribute name of the partition key for an index.

Specified by:

getIndexPartitionKey in interface TableMetadata

Parameters:

indexName - The name of the index.

Returns:

The attribute name representing the partition key for this index.

getIndexSortKey

public Optional<String> getIndexSortKey(String indexName)

Description copied from interface: TableMetadata

Returns the attribute name of the sort key for an index.

Specified by:

getIndexSortKey in interface TableMetadata

Parameters:

indexName - The name of the index.

Returns:

Optional of the attribute name representing the sort key for this index; empty if the index does not have a sort key.

getIndexKeys

public Collection<String> getIndexKeys(String indexName)

Description copied from interface: TableMetadata

Returns all the names of attributes associated with the keys of a specified index.

Specified by:

getIndexKeys in interface TableMetadata

Parameters:

indexName - The name of the index.

Returns:

A collection of all key attribute names for that index.

getAllKeys

public Collection<String> getAllKeys()

Description copied from interface: TableMetadata

Returns all the names of attributes associated with any index (primary or secondary) known for this table. Additionally any additional attributes that are deemed to be 'key-like' in how they should be treated will also be returned. An example of a 'key-like' attribute that is not actually a key is one tagged as a 'version' attribute when using the versioned record extension.

Specified by:

getAllKeys in interface TableMetadata

Returns:

A collection of all key attribute names for the table.

getScalarAttributeType

public Optional<ScalarAttributeType> getScalarAttributeType(String keyAttribute)

Description copied from interface: TableMetadata

Returns the DynamoDb scalar attribute type associated with a key attribute if one is applicable.

Specified by:

getScalarAttributeType in interface TableMetadata

Parameters:

keyAttribute - The key attribute name to return the scalar attribute type of.

Returns:

Optional ScalarAttributeType of the attribute, or empty if attribute is a non-scalar type.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object