Interface IndexMetadata

All Known Implementing Classes:

StaticIndexMetadata

@SdkPublicApi
@ThreadSafe
public interface IndexMetadata

A metadata class that stores information about an index

Method Summary

Modifier and Type	Method	Description
String	name()	The name of the index
Optional<KeyAttributeMetadata>	partitionKey()	The partition key for the index; if there is one.
Optional<KeyAttributeMetadata>	sortKey()	The sort key for the index; if there is one.

Method Details

name

String name()

The name of the index

partitionKey

Optional<KeyAttributeMetadata> partitionKey()

The partition key for the index; if there is one.

sortKey

Optional<KeyAttributeMetadata> sortKey()

The sort key for the index; if there is one.