@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class KeySchemaElement extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
KeySchemaElement()
Default constructor for KeySchemaElement object.
|
KeySchemaElement(String attributeName,
KeyType keyType)
Constructs a new KeySchemaElement object.
|
KeySchemaElement(String attributeName,
String keyType)
Constructs a new KeySchemaElement object.
|
Modifier and Type | Method and Description |
---|---|
KeySchemaElement |
clone() |
boolean |
equals(Object obj) |
String |
getAttributeName()
The name of a key attribute.
|
String |
getKeyType()
The role that this key attribute will assume:
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
void |
setAttributeName(String attributeName)
The name of a key attribute.
|
void |
setKeyType(KeyType keyType)
The role that this key attribute will assume:
|
void |
setKeyType(String keyType)
The role that this key attribute will assume:
|
String |
toString()
Returns a string representation of this object.
|
KeySchemaElement |
withAttributeName(String attributeName)
The name of a key attribute.
|
KeySchemaElement |
withKeyType(KeyType keyType)
The role that this key attribute will assume:
|
KeySchemaElement |
withKeyType(String keyType)
The role that this key attribute will assume:
|
public KeySchemaElement()
public KeySchemaElement(String attributeName, String keyType)
attributeName
- The name of a key attribute.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's 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.
public KeySchemaElement(String attributeName, KeyType keyType)
attributeName
- The name of a key attribute.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's 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.
public void setAttributeName(String attributeName)
The name of a key attribute.
attributeName
- The name of a key attribute.public String getAttributeName()
The name of a key attribute.
public KeySchemaElement withAttributeName(String attributeName)
The name of a key attribute.
attributeName
- The name of a key attribute.public void setKeyType(String 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's 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.
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's 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.
KeyType
public String getKeyType()
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's 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.
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's 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.
KeyType
public KeySchemaElement withKeyType(String 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's 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.
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's 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.
KeyType
public void setKeyType(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's 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.
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's 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.
KeyType
public KeySchemaElement withKeyType(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's 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.
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's 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.
KeyType
public String toString()
toString
in class Object
Object.toString()
public KeySchemaElement clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2024. All rights reserved.