DynamoDBAction (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.DynamoDBAction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DynamoDBAction
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

Constructor Summary

Constructors
Constructor and Description

DynamoDBAction()

Constructors
Constructor and Description
`DynamoDBAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DynamoDBAction`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getHashKeyField()` The hash key name.
`String`	`getHashKeyType()` The hash key type.
`String`	`getHashKeyValue()` The hash key value.
`String`	`getOperation()` The type of operation to be performed.
`String`	`getPayloadField()` The action payload.
`String`	`getRangeKeyField()` The range key name.
`String`	`getRangeKeyType()` The range key type.
`String`	`getRangeKeyValue()` The range key value.
`String`	`getRoleArn()` The ARN of the IAM role that grants access to the DynamoDB table.
`String`	`getTableName()` The name of the DynamoDB table.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHashKeyField(String hashKeyField)` The hash key name.
`void`	`setHashKeyType(DynamoKeyType hashKeyType)` The hash key type.
`void`	`setHashKeyType(String hashKeyType)` The hash key type.
`void`	`setHashKeyValue(String hashKeyValue)` The hash key value.
`void`	`setOperation(String operation)` The type of operation to be performed.
`void`	`setPayloadField(String payloadField)` The action payload.
`void`	`setRangeKeyField(String rangeKeyField)` The range key name.
`void`	`setRangeKeyType(DynamoKeyType rangeKeyType)` The range key type.
`void`	`setRangeKeyType(String rangeKeyType)` The range key type.
`void`	`setRangeKeyValue(String rangeKeyValue)` The range key value.
`void`	`setRoleArn(String roleArn)` The ARN of the IAM role that grants access to the DynamoDB table.
`void`	`setTableName(String tableName)` The name of the DynamoDB table.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DynamoDBAction`	`withHashKeyField(String hashKeyField)` The hash key name.
`DynamoDBAction`	`withHashKeyType(DynamoKeyType hashKeyType)` The hash key type.
`DynamoDBAction`	`withHashKeyType(String hashKeyType)` The hash key type.
`DynamoDBAction`	`withHashKeyValue(String hashKeyValue)` The hash key value.
`DynamoDBAction`	`withOperation(String operation)` The type of operation to be performed.
`DynamoDBAction`	`withPayloadField(String payloadField)` The action payload.
`DynamoDBAction`	`withRangeKeyField(String rangeKeyField)` The range key name.
`DynamoDBAction`	`withRangeKeyType(DynamoKeyType rangeKeyType)` The range key type.
`DynamoDBAction`	`withRangeKeyType(String rangeKeyType)` The range key type.
`DynamoDBAction`	`withRangeKeyValue(String rangeKeyValue)` The range key value.
`DynamoDBAction`	`withRoleArn(String roleArn)` The ARN of the IAM role that grants access to the DynamoDB table.
`DynamoDBAction`	`withTableName(String tableName)` The name of the DynamoDB table.

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

- Constructor Detail
  - DynamoDBAction
```
public DynamoDBAction()
```
- Method Detail
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the DynamoDB table.
    
    Parameters:
    
    tableName - The name of the DynamoDB table.
  - getTableName
```
public String getTableName()
```
    The name of the DynamoDB table.
    
    Returns:
    
    The name of the DynamoDB table.
  - withTableName
```
public DynamoDBAction withTableName(String tableName)
```
    The name of the DynamoDB table.
    
    Parameters:
    
    tableName - The name of the DynamoDB table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of the IAM role that grants access to the DynamoDB table.
    
    Parameters:
    
    roleArn - The ARN of the IAM role that grants access to the DynamoDB table.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public DynamoDBAction withRoleArn(String roleArn)
```
    The ARN of the IAM role that grants access to the DynamoDB table.
    
    Parameters:
    
    roleArn - The ARN of the IAM role that grants access to the DynamoDB table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperation
```
public void setOperation(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.
    
    Parameters:
    
    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.
  - getOperation
```
public String getOperation()
```
    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.
  - withOperation
```
public DynamoDBAction withOperation(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHashKeyField
```
public void setHashKeyField(String hashKeyField)
```
    The hash key name.
    
    Parameters:
    
    hashKeyField - The hash key name.
  - getHashKeyField
```
public String getHashKeyField()
```
    The hash key name.
    
    Returns:
    
    The hash key name.
  - withHashKeyField
```
public DynamoDBAction withHashKeyField(String hashKeyField)
```
    The hash key name.
    
    Parameters:
    
    hashKeyField - The hash key name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHashKeyValue
```
public void setHashKeyValue(String hashKeyValue)
```
    The hash key value.
    
    Parameters:
    
    hashKeyValue - The hash key value.
  - getHashKeyValue
```
public String getHashKeyValue()
```
    The hash key value.
    
    Returns:
    
    The hash key value.
  - withHashKeyValue
```
public DynamoDBAction withHashKeyValue(String hashKeyValue)
```
    The hash key value.
    
    Parameters:
    
    hashKeyValue - The hash key value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHashKeyType
```
public void setHashKeyType(String hashKeyType)
```
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    Parameters:
    
    hashKeyType - The hash key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - getHashKeyType
```
public String getHashKeyType()
```
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    Returns:
    
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - withHashKeyType
```
public DynamoDBAction withHashKeyType(String hashKeyType)
```
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    Parameters:
    
    hashKeyType - The hash key type. Valid values are "STRING" or "NUMBER"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DynamoKeyType
  - setHashKeyType
```
public void setHashKeyType(DynamoKeyType hashKeyType)
```
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    Parameters:
    
    hashKeyType - The hash key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - withHashKeyType
```
public DynamoDBAction withHashKeyType(DynamoKeyType hashKeyType)
```
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    Parameters:
    
    hashKeyType - The hash key type. Valid values are "STRING" or "NUMBER"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DynamoKeyType
  - setRangeKeyField
```
public void setRangeKeyField(String rangeKeyField)
```
    The range key name.
    
    Parameters:
    
    rangeKeyField - The range key name.
  - getRangeKeyField
```
public String getRangeKeyField()
```
    The range key name.
    
    Returns:
    
    The range key name.
  - withRangeKeyField
```
public DynamoDBAction withRangeKeyField(String rangeKeyField)
```
    The range key name.
    
    Parameters:
    
    rangeKeyField - The range key name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRangeKeyValue
```
public void setRangeKeyValue(String rangeKeyValue)
```
    The range key value.
    
    Parameters:
    
    rangeKeyValue - The range key value.
  - getRangeKeyValue
```
public String getRangeKeyValue()
```
    The range key value.
    
    Returns:
    
    The range key value.
  - withRangeKeyValue
```
public DynamoDBAction withRangeKeyValue(String rangeKeyValue)
```
    The range key value.
    
    Parameters:
    
    rangeKeyValue - The range key value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRangeKeyType
```
public void setRangeKeyType(String rangeKeyType)
```
    The range key type. Valid values are "STRING" or "NUMBER"
    
    Parameters:
    
    rangeKeyType - The range key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - getRangeKeyType
```
public String getRangeKeyType()
```
    The range key type. Valid values are "STRING" or "NUMBER"
    
    Returns:
    
    The range key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - withRangeKeyType
```
public DynamoDBAction withRangeKeyType(String rangeKeyType)
```
    The range key type. Valid values are "STRING" or "NUMBER"
    
    Parameters:
    
    rangeKeyType - The range key type. Valid values are "STRING" or "NUMBER"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DynamoKeyType
  - setRangeKeyType
```
public void setRangeKeyType(DynamoKeyType rangeKeyType)
```
    The range key type. Valid values are "STRING" or "NUMBER"
    
    Parameters:
    
    rangeKeyType - The range key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - withRangeKeyType
```
public DynamoDBAction withRangeKeyType(DynamoKeyType rangeKeyType)
```
    The range key type. Valid values are "STRING" or "NUMBER"
    
    Parameters:
    
    rangeKeyType - The range key type. Valid values are "STRING" or "NUMBER"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DynamoKeyType
  - setPayloadField
```
public void setPayloadField(String payloadField)
```
    The action payload. This name can be customized.
    
    Parameters:
    
    payloadField - The action payload. This name can be customized.
  - getPayloadField
```
public String getPayloadField()
```
    The action payload. This name can be customized.
    
    Returns:
    
    The action payload. This name can be customized.
  - withPayloadField
```
public DynamoDBAction withPayloadField(String payloadField)
```
    The action payload. This name can be customized.
    
    Parameters:
    
    payloadField - The action payload. This name can be customized.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 DynamoDBAction 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.

Did this page help you?

Class DynamoDBAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DynamoDBAction

Method Detail

setTableName

getTableName

withTableName

setRoleArn

getRoleArn

withRoleArn

setOperation

getOperation

withOperation

setHashKeyField

getHashKeyField

withHashKeyField

setHashKeyValue

getHashKeyValue

withHashKeyValue

setHashKeyType

getHashKeyType

withHashKeyType

setHashKeyType

withHashKeyType

setRangeKeyField

getRangeKeyField

withRangeKeyField

setRangeKeyValue

getRangeKeyValue

withRangeKeyValue

setRangeKeyType

getRangeKeyType

withRangeKeyType

setRangeKeyType

withRangeKeyType

setPayloadField

getPayloadField

withPayloadField

toString

equals

hashCode

clone

marshall