AttributeValue (AWS Java SDK :: Services :: Amazon DynamoDB 2.15.62 API)

java.lang.Object
- software.amazon.awssdk.services.dynamodb.model.AttributeValue

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AttributeValue.Builder,AttributeValue>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AttributeValue
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AttributeValue.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AttributeValue.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SdkBytes`	`b()` An attribute of type Binary.
`Boolean`	`bool()` An attribute of type Boolean.
`List<SdkBytes>`	`bs()` An attribute of type Binary Set.
`static AttributeValue.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBs()` Returns true if the BS property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasL()` Returns true if the L property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasM()` Returns true if the M property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNs()` Returns true if the NS property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSs()` Returns true if the SS property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<AttributeValue>`	`l()` An attribute of type List.
`Map<String,AttributeValue>`	`m()` An attribute of type Map.
`String`	`n()` An attribute of type Number.
`List<String>`	`ns()` An attribute of type Number Set.
`Boolean`	`nul()` An attribute of type Null.
`String`	`s()` An attribute of type String.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AttributeValue.Builder>`	`serializableBuilderClass()`
`List<String>`	`ss()` An attribute of type String Set.
`AttributeValue.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - s
```
public final String s()
```
    An attribute of type String. For example:
    
    "S": "Hello"
    
    Returns:
    
    An attribute of type String. For example:
    
    "S": "Hello"
  - n
```
public final 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:
    
    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
```
public final SdkBytes 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()
```
    Returns true if the SS property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - ss
```
public final List<String> 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.
    
    You can use hasSs() to see if a value was sent in this field.
    
    Returns:
    
    An attribute of type String Set. For example:
    
    "SS": ["Giraffe", "Hippo" ,"Zebra"]
  - hasNs
```
public final boolean hasNs()
```
    Returns true if the NS property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - ns
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNs() to see if a value was sent in this field.
    
    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()
```
    Returns true if the BS property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - bs
```
public final List<SdkBytes> 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.
    
    You can use hasBs() to see if a value was sent in this field.
    
    Returns:
    
    An attribute of type Binary Set. For example:
    
    "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
  - hasM
```
public final boolean hasM()
```
    Returns true if the M property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - m
```
public final Map<String,AttributeValue> 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.
    
    You can use hasM() to see if a value was sent in this field.
    
    Returns:
    
    An attribute of type Map. For example:
    
    "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
  - hasL
```
public final boolean hasL()
```
    Returns true if the L property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - l
```
public final List<AttributeValue> 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.
    
    You can use hasL() to see if a value was sent in this field.
    
    Returns:
    
    An attribute of type List. For example:
    
    "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]
  - bool
```
public final Boolean bool()
```
    An attribute of type Boolean. For example:
    
    "BOOL": true
    
    Returns:
    
    An attribute of type Boolean. For example:
    
    "BOOL": true
  - nul
```
public final Boolean nul()
```
    An attribute of type Null. For example:
    
    "NULL": true
    
    Returns:
    
    An attribute of type Null. For example:
    
    "NULL": true
  - toBuilder
```
public AttributeValue.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AttributeValue.Builder,AttributeValue>
  - builder
```
public static AttributeValue.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AttributeValue.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AttributeValue

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

s

n

b

hasSs

ss

hasNs

ns

hasBs

bs

hasM

m

hasL

l

bool

nul

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields