com.amazonaws.services.dynamodbv2.model

Class KeySchemaElement

java.lang.Object

com.amazonaws.services.dynamodbv2.model.KeySchemaElement

All Implemented Interfaces:

Serializable, Cloneable

public class KeySchemaElement
extends Object
implements Serializable, Cloneable

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 hash type primary key would be represented by one KeySchemaElement . A hash-and-range type primary key would require one KeySchemaElement for the hash attribute, and another KeySchemaElement for the range attribute.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeySchemaElement() Default constructor for a new KeySchemaElement object.
KeySchemaElement(String attributeName, KeyType keyType) Constructs a new KeySchemaElement object.
KeySchemaElement(String attributeName, String keyType) Constructs a new KeySchemaElement object.

Method Summary

Methods

Modifier and Type	Method and Description
KeySchemaElement	clone()
boolean	equals(Object obj)
String	getAttributeName() The name of a key attribute.
String	getKeyType() The attribute data, consisting of the data type and the attribute value itself.
int	hashCode()
void	setAttributeName(String attributeName) The name of a key attribute.
void	setKeyType(KeyType keyType) The attribute data, consisting of the data type and the attribute value itself.
void	setKeyType(String keyType) The attribute data, consisting of the data type and the attribute value itself.
String	toString() Returns a string representation of this object; useful for testing and debugging.
KeySchemaElement	withAttributeName(String attributeName) The name of a key attribute.
KeySchemaElement	withKeyType(KeyType keyType) The attribute data, consisting of the data type and the attribute value itself.
KeySchemaElement	withKeyType(String keyType) The attribute data, consisting of the data type and the attribute value itself.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeySchemaElement

public KeySchemaElement()

Default constructor for a new KeySchemaElement object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

KeySchemaElement

public KeySchemaElement(String attributeName,
                String keyType)

Constructs a new KeySchemaElement object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

attributeName - The name of a key attribute.

keyType - The attribute data, consisting of the data type and the attribute value itself.

KeySchemaElement

public KeySchemaElement(String attributeName,
                KeyType keyType)

Constructs a new KeySchemaElement object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

attributeName - The name of a key attribute.

keyType - The attribute data, consisting of the data type and the attribute value itself.

Method Detail

getAttributeName

public String getAttributeName()

The name of a key attribute.

Constraints:
Length: 1 - 255

Returns:

The name of a key attribute.

setAttributeName

public void setAttributeName(String attributeName)

The name of a key attribute.

Constraints:
Length: 1 - 255

Parameters:

attributeName - The name of a key attribute.

withAttributeName

public KeySchemaElement withAttributeName(String attributeName)

The name of a key attribute.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

Parameters:

attributeName - The name of a key attribute.

Returns:

A reference to this updated object so that method calls can be chained together.

getKeyType

public String getKeyType()

The attribute data, consisting of the data type and the attribute value itself.

Constraints:
Allowed Values: HASH, RANGE

Returns:

The attribute data, consisting of the data type and the attribute value itself.

See Also:

KeyType

setKeyType

public void setKeyType(String keyType)

The attribute data, consisting of the data type and the attribute value itself.

Constraints:
Allowed Values: HASH, RANGE

Parameters:

keyType - The attribute data, consisting of the data type and the attribute value itself.

See Also:

KeyType

withKeyType

public KeySchemaElement withKeyType(String keyType)

The attribute data, consisting of the data type and the attribute value itself.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: HASH, RANGE

Parameters:

keyType - The attribute data, consisting of the data type and the attribute value itself.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

KeyType

setKeyType

public void setKeyType(KeyType keyType)

The attribute data, consisting of the data type and the attribute value itself.

Constraints:
Allowed Values: HASH, RANGE

Parameters:

keyType - The attribute data, consisting of the data type and the attribute value itself.

See Also:

KeyType

withKeyType

public KeySchemaElement withKeyType(KeyType keyType)

The attribute data, consisting of the data type and the attribute value itself.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: HASH, RANGE

Parameters:

keyType - The attribute data, consisting of the data type and the attribute value itself.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

KeyType

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public KeySchemaElement clone()

Overrides:

clone in class Object