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
default Optional<KeyAttributeMetadata>	partitionKey()	Deprecated. Use partitionKeys() for unified single/composite key support
default List<KeyAttributeMetadata>	partitionKeys()	The partition keys for the index in order.
default Optional<KeyAttributeMetadata>	sortKey()	Deprecated. Use sortKeys() for unified single/composite key support
default List<KeyAttributeMetadata>	sortKeys()	The sort keys for the index in order.

Method Details

name

String name()

The name of the index

partitionKeys

default List<KeyAttributeMetadata> partitionKeys()

The partition keys for the index in order.

sortKeys

default List<KeyAttributeMetadata> sortKeys()

The sort keys for the index in order.

partitionKey

@Deprecated
default Optional<KeyAttributeMetadata> partitionKey()

Deprecated.

Use partitionKeys() for unified single/composite key support

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

sortKey

@Deprecated
default Optional<KeyAttributeMetadata> sortKey()

Deprecated.

Use sortKeys() for unified single/composite key support

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