software.amazon.awssdk.services.dynamodb.model

Class KeySchemaElement

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.KeySchemaElement

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KeySchemaElement.Builder,KeySchemaElement>

@Generated(value="software.amazon.awssdk:codegen")
public final class KeySchemaElement
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KeySchemaElement.Builder,KeySchemaElement>

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeySchemaElement.Builder

Method Summary

Modifier and Type	Method and Description
String	attributeName() The name of a key attribute.
static KeySchemaElement.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KeyType	keyType() The role that this key attribute will assume:
String	keyTypeAsString() The role that this key attribute will assume:
List<SdkField<?>>	sdkFields()
static Class<? extends KeySchemaElement.Builder>	serializableBuilderClass()
KeySchemaElement.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

attributeName

public String attributeName()

The name of a key attribute.

Returns:

The name of a key attribute.

keyType

public KeyType keyType()

The role that this key attribute will assume:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

If the service returns an enum value that is not available in the current SDK version, keyType will return KeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyTypeAsString().

Returns:

The role that this key attribute will assume:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

See Also:

KeyType

keyTypeAsString

public String keyTypeAsString()

The role that this key attribute will assume:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

If the service returns an enum value that is not available in the current SDK version, keyType will return KeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyTypeAsString().

Returns:

The role that this key attribute will assume:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

See Also:

KeyType

toBuilder

public KeySchemaElement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KeySchemaElement.Builder,KeySchemaElement>

builder

public static KeySchemaElement.Builder builder()

serializableBuilderClass

public static Class<? extends KeySchemaElement.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo