DynamoDBAction (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.iot.model.DynamoDBAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DynamoDBAction.Builder,DynamoDBAction>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DynamoDBAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DynamoDBAction.Builder,DynamoDBAction>
```
Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

"hashKeyValue": "${topic(3)}"

The following field uses the timestamp:

"rangeKeyValue": "${timestamp()}"

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DynamoDBAction.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DynamoDBAction.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`hashKeyField()` The hash key name.
`DynamoKeyType`	`hashKeyType()` The hash key type.
`String`	`hashKeyTypeAsString()` The hash key type.
`String`	`hashKeyValue()` The hash key value.
`String`	`operation()` The type of operation to be performed.
`String`	`payloadField()` The action payload.
`String`	`rangeKeyField()` The range key name.
`DynamoKeyType`	`rangeKeyType()` The range key type.
`String`	`rangeKeyTypeAsString()` The range key type.
`String`	`rangeKeyValue()` The range key value.
`String`	`roleArn()` The ARN of the IAM role that grants access to the DynamoDB table.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DynamoDBAction.Builder>`	`serializableBuilderClass()`
`String`	`tableName()` The name of the DynamoDB table.
`DynamoDBAction.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

- Method Detail
  - tableName
```
public String tableName()
```
    The name of the DynamoDB table.
    
    Returns:
    
    The name of the DynamoDB table.
  - roleArn
```
public String roleArn()
```
    The ARN of the IAM role that grants access to the DynamoDB table.
    
    Returns:
    
    The ARN of the IAM role that grants access to the DynamoDB table.
  - operation
```
public String operation()
```
    The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.
    
    Returns:
    
    The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.
  - hashKeyField
```
public String hashKeyField()
```
    The hash key name.
    
    Returns:
    
    The hash key name.
  - hashKeyValue
```
public String hashKeyValue()
```
    The hash key value.
    
    Returns:
    
    The hash key value.
  - hashKeyType
```
public DynamoKeyType hashKeyType()
```
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    If the service returns an enum value that is not available in the current SDK version, hashKeyType will return DynamoKeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hashKeyTypeAsString().
    
    Returns:
    
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - hashKeyTypeAsString
```
public String hashKeyTypeAsString()
```
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    If the service returns an enum value that is not available in the current SDK version, hashKeyType will return DynamoKeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hashKeyTypeAsString().
    
    Returns:
    
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - rangeKeyField
```
public String rangeKeyField()
```
    The range key name.
    
    Returns:
    
    The range key name.
  - rangeKeyValue
```
public String rangeKeyValue()
```
    The range key value.
    
    Returns:
    
    The range key value.
  - rangeKeyType
```
public DynamoKeyType rangeKeyType()
```
    The range key type. Valid values are "STRING" or "NUMBER"
    
    If the service returns an enum value that is not available in the current SDK version, rangeKeyType will return DynamoKeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rangeKeyTypeAsString().
    
    Returns:
    
    The range key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - rangeKeyTypeAsString
```
public String rangeKeyTypeAsString()
```
    The range key type. Valid values are "STRING" or "NUMBER"
    
    If the service returns an enum value that is not available in the current SDK version, rangeKeyType will return DynamoKeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rangeKeyTypeAsString().
    
    Returns:
    
    The range key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - payloadField
```
public String payloadField()
```
    The action payload. This name can be customized.
    
    Returns:
    
    The action payload. This name can be customized.
  - toBuilder
```
public DynamoDBAction.Builder 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 interface ToCopyableBuilder<DynamoDBAction.Builder,DynamoDBAction>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DynamoDBAction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DynamoDBAction.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class DynamoDBAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

tableName

roleArn

operation

hashKeyField

hashKeyValue

hashKeyType

hashKeyTypeAsString

rangeKeyField

rangeKeyValue

rangeKeyType

rangeKeyTypeAsString

payloadField

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields