DynamoDBAction (AWS SDK for Android

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

All Implemented Interfaces:

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

Class DynamoDBAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DynamoDBAction

Method Detail

getTableName

setTableName

withTableName

getRoleArn

setRoleArn

withRoleArn

getOperation

setOperation

withOperation

getHashKeyField

setHashKeyField

withHashKeyField

getHashKeyValue

setHashKeyValue

withHashKeyValue

getHashKeyType

setHashKeyType

withHashKeyType

setHashKeyType

withHashKeyType

getRangeKeyField

setRangeKeyField

withRangeKeyField

getRangeKeyValue

setRangeKeyValue

withRangeKeyValue

getRangeKeyType

setRangeKeyType

withRangeKeyType

setRangeKeyType

withRangeKeyType

getPayloadField

setPayloadField

withPayloadField

toString

hashCode

equals