software.amazon.awssdk.extensions.dynamodb.mappingclient

Class Key

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.Key

public class Key
extends Object

An object that represents a key that can be used to either identify a specific record or form part of a query conditional. Keys are literal and hence not typed, and can be re-used in commands for different modelled types if the literal values are to be the same. A key will always have a single partition key value associated with it, and optionally will have a sort key value. The names of the keys themselves are not part of this object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<String,AttributeValue>	getKeyMap(TableSchema<?> tableSchema, String index) Return a map of the key elements that can be passed directly to DynamoDb.
AttributeValue	getPartitionKeyValue() Get the literal value of the partition key stored in this object.
Map<String,AttributeValue>	getPrimaryKeyMap(TableSchema<?> tableSchema) Return a map of the key elements that form the primary key of a table that can be passed directly to DynamoDb.
Optional<AttributeValue>	getSortKeyValue() Get the literal value of the sort key stored in this object if available.
int	hashCode()
static Key	of(AttributeValue partitionKeyValue) Construct a literal key with just a partition key value.
static Key	of(AttributeValue partitionKeyValue, AttributeValue sortKeyValue) Construct a literal key with both a partition key value and a sort key value.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static Key of(AttributeValue partitionKeyValue)

Construct a literal key with just a partition key value.

Parameters:

partitionKeyValue - A DynamoDb AttributeValue that is the literal value of the partition key.

Returns:

A key.

of

public static Key of(AttributeValue partitionKeyValue,
                     AttributeValue sortKeyValue)

Construct a literal key with both a partition key value and a sort key value.

Parameters:

partitionKeyValue - A DynamoDb AttributeValue that is the literal value of the partition key.

sortKeyValue - A DynamoDb AttributeValue that is the literal value of the sort key.

Returns:

A key.

getKeyMap

public Map<String,AttributeValue> getKeyMap(TableSchema<?> tableSchema,
                                            String index)

Return a map of the key elements that can be passed directly to DynamoDb.

Parameters:

tableSchema - A tableschema to determine the key attribute names from.

index - The name of the index to use when determining the key attribute names.

Returns:

A map of attribute names to AttributeValue.

getPartitionKeyValue

public AttributeValue getPartitionKeyValue()

Get the literal value of the partition key stored in this object.

Returns:

An AttributeValue representing the literal value of the partition key.

getSortKeyValue

public Optional<AttributeValue> getSortKeyValue()

Get the literal value of the sort key stored in this object if available.

Returns:

An optional AttributeValue representing the literal value of the sort key, or empty if there is no sort key value in this Key.

getPrimaryKeyMap

public Map<String,AttributeValue> getPrimaryKeyMap(TableSchema<?> tableSchema)

Return a map of the key elements that form the primary key of a table that can be passed directly to DynamoDb.

Parameters:

tableSchema - A tableschema to determine the key attribute names from.

Returns:

A map of attribute names to AttributeValue.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object