Interface IndexMetadata
-
- All Known Implementing Classes:
StaticIndexMetadata
@SdkPublicApi @ThreadSafe public interface IndexMetadata
A metadata class that stores information about an index
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description Stringname()The name of the indexdefault Optional<KeyAttributeMetadata>partitionKey()Deprecated.UsepartitionKeys()for unified single/composite key supportdefault List<KeyAttributeMetadata>partitionKeys()The partition keys for the index in order.default Optional<KeyAttributeMetadata>sortKey()Deprecated.UsesortKeys()for unified single/composite key supportdefault List<KeyAttributeMetadata>sortKeys()The sort keys for the index in order.
-
-
-
Method Detail
-
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.UsepartitionKeys()for unified single/composite key supportThe partition key for the index; if there is one.
-
sortKey
@Deprecated default Optional<KeyAttributeMetadata> sortKey()
Deprecated.UsesortKeys()for unified single/composite key supportThe sort key for the index; if there is one.
-
-