com.amazonaws.services.dynamodb.model
Class Key

java.lang.Object
  com.amazonaws.services.dynamodb.model.Key

public class Key
extends Object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Constructor Summary

Key()
Default constructor for a new Key object.

Key(AttributeValue hashKeyElement)
Constructs a new Key object.

Key(AttributeValue hashKeyElement, AttributeValue rangeKeyElement)
Constructs a new Key object.

Method Summary

boolean	equals(Object obj)
AttributeValue	getHashKeyElement() A hash key element is treated as the primary key, and can be a string or a number.
AttributeValue	getRangeKeyElement() A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys.
int	hashCode()
void	setHashKeyElement(AttributeValue hashKeyElement) A hash key element is treated as the primary key, and can be a string or a number.
void	setRangeKeyElement(AttributeValue rangeKeyElement) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Key	withHashKeyElement(AttributeValue hashKeyElement) A hash key element is treated as the primary key, and can be a string or a number.
Key	withRangeKeyElement(AttributeValue rangeKeyElement) A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Key

public Key()

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

Key

public Key(AttributeValue hashKeyElement)

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

Parameters:

hashKeyElement - A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

Key

public Key(AttributeValue hashKeyElement,
           AttributeValue rangeKeyElement)

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

Parameters:

hashKeyElement - A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

rangeKeyElement - A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

Method Detail

getHashKeyElement

public AttributeValue getHashKeyElement()

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

Returns:

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

setHashKeyElement

public void setHashKeyElement(AttributeValue hashKeyElement)

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

Parameters:

hashKeyElement - A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

withHashKeyElement

public Key withHashKeyElement(AttributeValue hashKeyElement)

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

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

Parameters:

hashKeyElement - A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

Returns:

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

getRangeKeyElement

public AttributeValue getRangeKeyElement()

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

Returns:

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

setRangeKeyElement

public void setRangeKeyElement(AttributeValue rangeKeyElement)

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

Parameters:

rangeKeyElement - A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

withRangeKeyElement

public Key withRangeKeyElement(AttributeValue rangeKeyElement)

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

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

Parameters:

rangeKeyElement - A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

Returns:

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

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