com.amazonaws.services.dynamodbv2.model

Class AttributeValue

java.lang.Object

com.amazonaws.services.dynamodbv2.model.AttributeValue

All Implemented Interfaces:

java.io.Serializable

public class AttributeValue
extends java.lang.Object
implements java.io.Serializable

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeValue() Default constructor for AttributeValue object.
AttributeValue(java.util.List<java.lang.String> sS) Constructs a new AttributeValue object.
AttributeValue(java.lang.String s) Constructs a new AttributeValue object.

Method Summary

Modifier and Type	Method and Description
AttributeValue	addMEntry(java.lang.String key, AttributeValue value) An attribute of type Map.
AttributeValue	clearMEntries() Removes all the entries added into M.
boolean	equals(java.lang.Object obj)
java.nio.ByteBuffer	getB() An attribute of type Binary.
java.lang.Boolean	getBOOL() An attribute of type Boolean.
java.util.List<java.nio.ByteBuffer>	getBS() An attribute of type Binary Set.
java.util.List<AttributeValue>	getL() An attribute of type List.
java.util.Map<java.lang.String,AttributeValue>	getM() An attribute of type Map.
java.lang.String	getN() An attribute of type Number.
java.util.List<java.lang.String>	getNS() An attribute of type Number Set.
java.lang.Boolean	getNULL() An attribute of type Null.
java.lang.String	getS() An attribute of type String.
java.util.List<java.lang.String>	getSS() An attribute of type String Set.
int	hashCode()
java.lang.Boolean	isBOOL() An attribute of type Boolean.
java.lang.Boolean	isNULL() An attribute of type Null.
void	setB(java.nio.ByteBuffer b) An attribute of type Binary.
void	setBOOL(java.lang.Boolean bOOL) An attribute of type Boolean.
void	setBS(java.util.Collection<java.nio.ByteBuffer> bS) An attribute of type Binary Set.
void	setL(java.util.Collection<AttributeValue> l) An attribute of type List.
void	setM(java.util.Map<java.lang.String,AttributeValue> m) An attribute of type Map.
void	setN(java.lang.String n) An attribute of type Number.
void	setNS(java.util.Collection<java.lang.String> nS) An attribute of type Number Set.
void	setNULL(java.lang.Boolean nULL) An attribute of type Null.
void	setS(java.lang.String s) An attribute of type String.
void	setSS(java.util.Collection<java.lang.String> sS) An attribute of type String Set.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
AttributeValue	withB(java.nio.ByteBuffer b) An attribute of type Binary.
AttributeValue	withBOOL(java.lang.Boolean bOOL) An attribute of type Boolean.
AttributeValue	withBS(java.nio.ByteBuffer... bS) An attribute of type Binary Set.
AttributeValue	withBS(java.util.Collection<java.nio.ByteBuffer> bS) An attribute of type Binary Set.
AttributeValue	withL(AttributeValue... l) An attribute of type List.
AttributeValue	withL(java.util.Collection<AttributeValue> l) An attribute of type List.
AttributeValue	withM(java.util.Map<java.lang.String,AttributeValue> m) An attribute of type Map.
AttributeValue	withN(java.lang.String n) An attribute of type Number.
AttributeValue	withNS(java.util.Collection<java.lang.String> nS) An attribute of type Number Set.
AttributeValue	withNS(java.lang.String... nS) An attribute of type Number Set.
AttributeValue	withNULL(java.lang.Boolean nULL) An attribute of type Null.
AttributeValue	withS(java.lang.String s) An attribute of type String.
AttributeValue	withSS(java.util.Collection<java.lang.String> sS) An attribute of type String Set.
AttributeValue	withSS(java.lang.String... sS) An attribute of type String Set.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributeValue

public AttributeValue()

Default constructor for AttributeValue object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

AttributeValue

public AttributeValue(java.lang.String s)

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

Parameters:

s -

An attribute of type String. For example:

"S": "Hello"

AttributeValue

public AttributeValue(java.util.List<java.lang.String> sS)

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

Parameters:

sS -

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

Method Detail

getS

public java.lang.String getS()

An attribute of type String. For example:

"S": "Hello"

Returns:

An attribute of type String. For example:

"S": "Hello"

setS

public void setS(java.lang.String s)

An attribute of type String. For example:

"S": "Hello"

Parameters:

s -

An attribute of type String. For example:

"S": "Hello"

withS

public AttributeValue withS(java.lang.String s)

An attribute of type String. For example:

"S": "Hello"

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

Parameters:

s -

An attribute of type String. For example:

"S": "Hello"

Returns:

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

getN

public java.lang.String getN()

An attribute of type Number. For example:

"N": "123.45"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Returns:

An attribute of type Number. For example:

"N": "123.45"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

setN

public void setN(java.lang.String n)

An attribute of type Number. For example:

"N": "123.45"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Parameters:

n -

An attribute of type Number. For example:

"N": "123.45"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

withN

public AttributeValue withN(java.lang.String n)

An attribute of type Number. For example:

"N": "123.45"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

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

Parameters:

n -

An attribute of type Number. For example:

"N": "123.45"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Returns:

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

getB

public java.nio.ByteBuffer getB()

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

Returns:

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

setB

public void setB(java.nio.ByteBuffer b)

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

Parameters:

b -

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

withB

public AttributeValue withB(java.nio.ByteBuffer b)

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

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

Parameters:

b -

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

Returns:

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

getSS

public java.util.List<java.lang.String> getSS()

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

Returns:

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

setSS

public void setSS(java.util.Collection<java.lang.String> sS)

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

Parameters:

sS -

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

withSS

public AttributeValue withSS(java.lang.String... sS)

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

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

Parameters:

sS -

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

Returns:

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

withSS

public AttributeValue withSS(java.util.Collection<java.lang.String> sS)

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

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

Parameters:

sS -

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

Returns:

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

getNS

public java.util.List<java.lang.String> getNS()

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Returns:

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

setNS

public void setNS(java.util.Collection<java.lang.String> nS)

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Parameters:

nS -

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

withNS

public AttributeValue withNS(java.lang.String... nS)

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

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

Parameters:

nS -

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Returns:

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

withNS

public AttributeValue withNS(java.util.Collection<java.lang.String> nS)

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

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

Parameters:

nS -

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Returns:

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

getBS

public java.util.List<java.nio.ByteBuffer> getBS()

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

Returns:

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

setBS

public void setBS(java.util.Collection<java.nio.ByteBuffer> bS)

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

Parameters:

bS -

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

withBS

public AttributeValue withBS(java.nio.ByteBuffer... bS)

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

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

Parameters:

bS -

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

Returns:

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

withBS

public AttributeValue withBS(java.util.Collection<java.nio.ByteBuffer> bS)

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

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

Parameters:

bS -

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

Returns:

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

getM

public java.util.Map<java.lang.String,AttributeValue> getM()

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

Returns:

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

setM

public void setM(java.util.Map<java.lang.String,AttributeValue> m)

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

Parameters:

m -

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

withM

public AttributeValue withM(java.util.Map<java.lang.String,AttributeValue> m)

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

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

Parameters:

m -

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

Returns:

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

addMEntry

public AttributeValue addMEntry(java.lang.String key,
                                AttributeValue value)

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

The method adds a new key-value pair into M parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into M.

value - The corresponding value of the entry to be added into M.

Returns:

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

clearMEntries

public AttributeValue clearMEntries()

Removes all the entries added into M.

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

getL

public java.util.List<AttributeValue> getL()

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

Returns:

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

setL

public void setL(java.util.Collection<AttributeValue> l)

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

Parameters:

l -

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

withL

public AttributeValue withL(AttributeValue... l)

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

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

Parameters:

l -

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

Returns:

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

withL

public AttributeValue withL(java.util.Collection<AttributeValue> l)

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

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

Parameters:

l -

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

Returns:

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

isNULL

public java.lang.Boolean isNULL()

An attribute of type Null. For example:

"NULL": true

Returns:

An attribute of type Null. For example:

"NULL": true

getNULL

public java.lang.Boolean getNULL()

An attribute of type Null. For example:

"NULL": true

Returns:

An attribute of type Null. For example:

"NULL": true

setNULL

public void setNULL(java.lang.Boolean nULL)

An attribute of type Null. For example:

"NULL": true

Parameters:

nULL -

An attribute of type Null. For example:

"NULL": true

withNULL

public AttributeValue withNULL(java.lang.Boolean nULL)

An attribute of type Null. For example:

"NULL": true

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

Parameters:

nULL -

An attribute of type Null. For example:

"NULL": true

Returns:

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

isBOOL

public java.lang.Boolean isBOOL()

An attribute of type Boolean. For example:

"BOOL": true

Returns:

An attribute of type Boolean. For example:

"BOOL": true

getBOOL

public java.lang.Boolean getBOOL()

An attribute of type Boolean. For example:

"BOOL": true

Returns:

An attribute of type Boolean. For example:

"BOOL": true

setBOOL

public void setBOOL(java.lang.Boolean bOOL)

An attribute of type Boolean. For example:

"BOOL": true

Parameters:

bOOL -

An attribute of type Boolean. For example:

"BOOL": true

withBOOL

public AttributeValue withBOOL(java.lang.Boolean bOOL)

An attribute of type Boolean. For example:

"BOOL": true

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

Parameters:

bOOL -

An attribute of type Boolean. For example:

"BOOL": true

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object