Class AttributeValue
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AttributeValue.Builder,
AttributeValue>
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionfinal SdkBytes
b()
An attribute of type Binary.final Boolean
bool()
An attribute of type Boolean.bs()
An attribute of type Binary Set.static AttributeValue.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static AttributeValue
Create an instance of this class withb()
initialized to the given value.static AttributeValue
Create an instance of this class withbool()
initialized to the given value.static AttributeValue
Create an instance of this class withbs()
initialized to the given value.static AttributeValue
fromL
(List<AttributeValue> l) Create an instance of this class withl()
initialized to the given value.static AttributeValue
fromM
(Map<String, AttributeValue> m) Create an instance of this class withm()
initialized to the given value.static AttributeValue
Create an instance of this class withn()
initialized to the given value.static AttributeValue
Create an instance of this class withns()
initialized to the given value.static AttributeValue
Create an instance of this class withnul()
initialized to the given value.static AttributeValue
Create an instance of this class withs()
initialized to the given value.static AttributeValue
Create an instance of this class withss()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
hasBs()
For responses, this returns true if the service returned a value for the BS property.final int
hashCode()
final boolean
hasL()
For responses, this returns true if the service returned a value for the L property.final boolean
hasM()
For responses, this returns true if the service returned a value for the M property.final boolean
hasNs()
For responses, this returns true if the service returned a value for the NS property.final boolean
hasSs()
For responses, this returns true if the service returned a value for the SS property.final List
<AttributeValue> l()
An attribute of type List.final Map
<String, AttributeValue> m()
An attribute of type Map.final String
n()
An attribute of type Number.ns()
An attribute of type Number Set.final Boolean
nul()
An attribute of type Null.final String
s()
An attribute of type String.static Class
<? extends AttributeValue.Builder> ss()
An attribute of type String Set.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
s
An attribute of type String. For example:
"S": "Hello"
- Returns:
- An attribute of type String. For example:
"S": "Hello"
-
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:
- 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.
-
b
An attribute of type Binary. For example:
"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
- Returns:
- An attribute of type Binary. For example:
"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
-
hasSs
public final boolean hasSs()For responses, this returns true if the service returned a value for the SS property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
ss
An attribute of type String Set. For example:
"SS": ["Giraffe", "Hippo" ,"Zebra"]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSs()
method.- Returns:
- An attribute of type String Set. For example:
"SS": ["Giraffe", "Hippo" ,"Zebra"]
-
hasNs
public final boolean hasNs()For responses, this returns true if the service returned a value for the NS property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasNs()
method.- 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.
-
hasBs
public final boolean hasBs()For responses, this returns true if the service returned a value for the BS property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
bs
An attribute of type Binary Set. For example:
"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasBs()
method.- Returns:
- An attribute of type Binary Set. For example:
"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
-
hasM
public final boolean hasM()For responses, this returns true if the service returned a value for the M property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
m
An attribute of type Map. For example:
"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasM()
method.- Returns:
- An attribute of type Map. For example:
"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
-
hasL
public final boolean hasL()For responses, this returns true if the service returned a value for the L property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
l
An attribute of type List. For example:
"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasL()
method.- Returns:
- An attribute of type List. For example:
"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]
-
bool
An attribute of type Boolean. For example:
"BOOL": true
- Returns:
- An attribute of type Boolean. For example:
"BOOL": true
-
nul
An attribute of type Null. For example:
"NULL": true
- Returns:
- An attribute of type Null. For example:
"NULL": true
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AttributeValue.Builder,
AttributeValue> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromS
Create an instance of this class withs()
initialized to the given value.An attribute of type String. For example:
"S": "Hello"
- Parameters:
s
- An attribute of type String. For example:"S": "Hello"
-
fromN
Create an instance of this class withn()
initialized to the given value.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.
-
fromB
Create an instance of this class withb()
initialized to the given value.An attribute of type Binary. For example:
"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
- Parameters:
b
- An attribute of type Binary. For example:"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
-
fromSs
Create an instance of this class withss()
initialized to the given value.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"]
-
fromNs
Create an instance of this class withns()
initialized to the given value.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.
-
fromBs
Create an instance of this class withbs()
initialized to the given value.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="]
-
fromM
Create an instance of this class withm()
initialized to the given value.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"}}
-
fromL
Create an instance of this class withl()
initialized to the given value.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"}]
-
fromBool
Create an instance of this class withbool()
initialized to the given value.An attribute of type Boolean. For example:
"BOOL": true
- Parameters:
bool
- An attribute of type Boolean. For example:"BOOL": true
-
fromNul
Create an instance of this class withnul()
initialized to the given value.An attribute of type Null. For example:
"NULL": true
- Parameters:
nul
- An attribute of type Null. For example:"NULL": true
-
type
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beAttributeValue.Type.UNKNOWN_TO_SDK_VERSION
if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beAttributeValue.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-