com.amazonaws.services.dynamodbv2.model

Class AttributeValue

java.lang.Object

com.amazonaws.services.dynamodbv2.model.AttributeValue

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AttributeValue
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AttributeValue	addMEntry(String key, AttributeValue value) Add a single M entry
AttributeValue	clearMEntries() Removes all the entries added into M.
AttributeValue	clone()
boolean	equals(Object obj)
ByteBuffer	getB() An attribute of type Binary.
Boolean	getBOOL() An attribute of type Boolean.
List<ByteBuffer>	getBS() An attribute of type Binary Set.
List<AttributeValue>	getL() An attribute of type List.
Map<String,AttributeValue>	getM() An attribute of type Map.
String	getN() An attribute of type Number.
List<String>	getNS() An attribute of type Number Set.
Boolean	getNULL() An attribute of type Null.
String	getS() An attribute of type String.
List<String>	getSS() An attribute of type String Set.
int	hashCode()
Boolean	isBOOL() An attribute of type Boolean.
Boolean	isNULL() An attribute of type Null.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setB(ByteBuffer b) An attribute of type Binary.
void	setBOOL(Boolean bOOL) An attribute of type Boolean.
void	setBS(Collection<ByteBuffer> bS) An attribute of type Binary Set.
void	setL(Collection<AttributeValue> l) An attribute of type List.
void	setM(Map<String,AttributeValue> m) An attribute of type Map.
void	setN(String n) An attribute of type Number.
void	setNS(Collection<String> nS) An attribute of type Number Set.
void	setNULL(Boolean nULLValue) An attribute of type Null.
void	setS(String s) An attribute of type String.
void	setSS(Collection<String> sS) An attribute of type String Set.
String	toString() Returns a string representation of this object.
AttributeValue	withB(ByteBuffer b) An attribute of type Binary.
AttributeValue	withBOOL(Boolean bOOL) An attribute of type Boolean.
AttributeValue	withBS(ByteBuffer... bS) An attribute of type Binary Set.
AttributeValue	withBS(Collection<ByteBuffer> bS) An attribute of type Binary Set.
AttributeValue	withL(AttributeValue... l) An attribute of type List.
AttributeValue	withL(Collection<AttributeValue> l) An attribute of type List.
AttributeValue	withM(Map<String,AttributeValue> m) An attribute of type Map.
AttributeValue	withN(String n) An attribute of type Number.
AttributeValue	withNS(Collection<String> nS) An attribute of type Number Set.
AttributeValue	withNS(String... nS) An attribute of type Number Set.
AttributeValue	withNULL(Boolean nULLValue) An attribute of type Null.
AttributeValue	withS(String s) An attribute of type String.
AttributeValue	withSS(Collection<String> sS) An attribute of type String Set.
AttributeValue	withSS(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 the object after creating it.

AttributeValue

public AttributeValue(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(List<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

setS

public void setS(String s)

An attribute of type String. For example:

"S": "Hello"

Parameters:

s - An attribute of type String. For example:

"S": "Hello"

getS

public String getS()

An attribute of type String. For example:

"S": "Hello"

Returns:

An attribute of type String. For example:

"S": "Hello"

withS

public AttributeValue withS(String s)

An attribute of type String. For example:

"S": "Hello"

Parameters:

s - An attribute of type String. For example:

"S": "Hello"

Returns:

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

setN

public void setN(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.

getN

public 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.

withN

public AttributeValue withN(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.

Returns:

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

setB

public void setB(ByteBuffer b)

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

b - An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

getB

public ByteBuffer getB()

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

withB

public AttributeValue withB(ByteBuffer b)

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

b - An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

Returns:

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

getSS

public List<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(Collection<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(String... sS)

An attribute of type String Set. For example:

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

NOTE: This method appends the values to the existing list (if any). Use setSS(java.util.Collection) or withSS(java.util.Collection) if you want to override the existing values.

Parameters:

sS - An attribute of type String Set. For example:

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

Returns:

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

withSS

public AttributeValue withSS(Collection<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"]

Returns:

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

getNS

public List<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(Collection<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(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.

NOTE: This method appends the values to the existing list (if any). Use setNS(java.util.Collection) or withNS(java.util.Collection) if you want to override the existing values.

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:

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

withNS

public AttributeValue withNS(Collection<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.

Returns:

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

getBS

public List<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(Collection<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(ByteBuffer... bS)

An attribute of type Binary Set. For example:

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

NOTE: This method appends the values to the existing list (if any). Use setBS(java.util.Collection) or withBS(java.util.Collection) if you want to override the existing values.

Parameters:

bS - An attribute of type Binary Set. For example:

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

Returns:

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

withBS

public AttributeValue withBS(Collection<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="]

Returns:

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

getM

public Map<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(Map<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(Map<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"}}

Returns:

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

addMEntry

public AttributeValue addMEntry(String key,
                                AttributeValue value)

Add a single M entry

See Also:

withM(java.util.Map<java.lang.String, com.amazonaws.services.dynamodbv2.model.AttributeValue>)

clearMEntries

public AttributeValue clearMEntries()

Removes all the entries added into M.

Returns:

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

getL

public List<AttributeValue> getL()

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

Returns:

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

setL

public void setL(Collection<AttributeValue> l)

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

Parameters:

l - An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

withL

public AttributeValue withL(AttributeValue... l)

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

NOTE: This method appends the values to the existing list (if any). Use setL(java.util.Collection) or withL(java.util.Collection) if you want to override the existing values.

Parameters:

l - An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

Returns:

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

withL

public AttributeValue withL(Collection<AttributeValue> l)

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

Parameters:

l - An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

Returns:

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

setNULL

public void setNULL(Boolean nULLValue)

An attribute of type Null. For example:

"NULL": true

Parameters:

nULLValue - An attribute of type Null. For example:

"NULL": true

getNULL

public Boolean getNULL()

An attribute of type Null. For example:

"NULL": true

Returns:

An attribute of type Null. For example:

"NULL": true

withNULL

public AttributeValue withNULL(Boolean nULLValue)

An attribute of type Null. For example:

"NULL": true

Parameters:

nULLValue - An attribute of type Null. For example:

"NULL": true

Returns:

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

isNULL

public Boolean isNULL()

An attribute of type Null. For example:

"NULL": true

Returns:

An attribute of type Null. For example:

"NULL": true

setBOOL

public void setBOOL(Boolean bOOL)

An attribute of type Boolean. For example:

"BOOL": true

Parameters:

bOOL - An attribute of type Boolean. For example:

"BOOL": true

getBOOL

public Boolean getBOOL()

An attribute of type Boolean. For example:

"BOOL": true

Returns:

An attribute of type Boolean. For example:

"BOOL": true

withBOOL

public AttributeValue withBOOL(Boolean bOOL)

An attribute of type Boolean. For example:

"BOOL": true

Parameters:

bOOL - An attribute of type Boolean. For example:

"BOOL": true

Returns:

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

isBOOL

public Boolean isBOOL()

An attribute of type Boolean. For example:

"BOOL": true

Returns:

An attribute of type Boolean. For example:

"BOOL": true

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AttributeValue clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.