software.amazon.awssdk.enhanced.dynamodb.mapper

Class StaticAttributeTags

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.mapper.StaticAttributeTags

public final class StaticAttributeTags
extends Object

Common implementations of StaticAttributeTag. These tags can be used to mark your attributes as primary or secondary keys in your StaticTableSchema definitions.

Method Summary

Modifier and Type	Method and Description
static StaticAttributeTag	primaryPartitionKey() Marks an attribute as being the primary partition key of the table it participates in.
static StaticAttributeTag	primarySortKey() Marks an attribute as being the primary sort key of the table it participates in.
static StaticAttributeTag	secondaryPartitionKey(Collection<String> indexNames) Marks an attribute as being a partition key for multiple secondary indices.
static StaticAttributeTag	secondaryPartitionKey(String indexName) Marks an attribute as being a partition key for a secondary index.
static StaticAttributeTag	secondarySortKey(Collection<String> indexNames) Marks an attribute as being a sort key for multiple secondary indices.
static StaticAttributeTag	secondarySortKey(String indexName) Marks an attribute as being a sort key for a secondary index.
static StaticAttributeTag	updateBehavior(UpdateBehavior updateBehavior) Specifies the behavior when this attribute is updated as part of an 'update' operation such as UpdateItem.

Methods inherited from class java.lang.Object

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

Method Detail

primaryPartitionKey

public static StaticAttributeTag primaryPartitionKey()

Marks an attribute as being the primary partition key of the table it participates in. Only one attribute can be marked this way in a given table schema.

primarySortKey

public static StaticAttributeTag primarySortKey()

Marks an attribute as being the primary sort key of the table it participates in. Only one attribute can be marked this way in a given table schema.

secondaryPartitionKey

public static StaticAttributeTag secondaryPartitionKey(String indexName)

Marks an attribute as being a partition key for a secondary index.

Parameters:

indexName - The name of the index this key participates in.

secondaryPartitionKey

public static StaticAttributeTag secondaryPartitionKey(Collection<String> indexNames)

Marks an attribute as being a partition key for multiple secondary indices.

Parameters:

indexNames - The names of the indices this key participates in.

secondarySortKey

public static StaticAttributeTag secondarySortKey(String indexName)

Marks an attribute as being a sort key for a secondary index.

Parameters:

indexName - The name of the index this key participates in.

secondarySortKey

public static StaticAttributeTag secondarySortKey(Collection<String> indexNames)

Marks an attribute as being a sort key for multiple secondary indices.

Parameters:

indexNames - The names of the indices this key participates in.

updateBehavior

public static StaticAttributeTag updateBehavior(UpdateBehavior updateBehavior)

Specifies the behavior when this attribute is updated as part of an 'update' operation such as UpdateItem. See documentation of UpdateBehavior for details on the different behaviors supported and the default behavior.

Parameters:

updateBehavior - The UpdateBehavior to be applied to this attribute