DynamoDBAction (AWS Java SDK for AWS IoT Events 1.11.953 API)

java.lang.Object
- com.amazonaws.services.iotevents.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
```
Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

The tableName and hashKeyField values must match the table name and the partition key of the DynamoDB table.

If the DynamoDB table also has a sort key, you must specify rangeKeyField. The rangeKeyField value must match the sort key.

The hashKeyValue and rangeKeyValue use substitution templates. These templates provide data at runtime. The syntax is ${sql-expression}.

You can use expressions for parameters that are string data type. For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The payloadField is <payload-field>_raw.

See Also:

AWS API Documentation, 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 name of the hash key (also called the partition key).
`String`	`getHashKeyType()` The data type for the hash key (also called the partition key).
`String`	`getHashKeyValue()` The value of the hash key (also called the partition key).
`String`	`getOperation()` The type of operation to perform.
`Payload`	`getPayload()`
`String`	`getPayloadField()` The name of the DynamoDB column that receives the action payload.
`String`	`getRangeKeyField()` The name of the range key (also called the sort key).
`String`	`getRangeKeyType()` The data type for the range key (also called the sort key), You can specify the following values:
`String`	`getRangeKeyValue()` The value of the range key (also called the sort key).
`String`	`getTableName()` The name of the DynamoDB table.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setHashKeyField(String hashKeyField)` The name of the hash key (also called the partition key).
`void`	`setHashKeyType(String hashKeyType)` The data type for the hash key (also called the partition key).
`void`	`setHashKeyValue(String hashKeyValue)` The value of the hash key (also called the partition key).
`void`	`setOperation(String operation)` The type of operation to perform.
`void`	`setPayload(Payload payload)`
`void`	`setPayloadField(String payloadField)` The name of the DynamoDB column that receives the action payload.
`void`	`setRangeKeyField(String rangeKeyField)` The name of the range key (also called the sort key).
`void`	`setRangeKeyType(String rangeKeyType)` The data type for the range key (also called the sort key), You can specify the following values:
`void`	`setRangeKeyValue(String rangeKeyValue)` The value of the range key (also called the sort key).
`void`	`setTableName(String tableName)` The name of the DynamoDB table.
`String`	`toString()` Returns a string representation of this object.
`DynamoDBAction`	`withHashKeyField(String hashKeyField)` The name of the hash key (also called the partition key).
`DynamoDBAction`	`withHashKeyType(String hashKeyType)` The data type for the hash key (also called the partition key).
`DynamoDBAction`	`withHashKeyValue(String hashKeyValue)` The value of the hash key (also called the partition key).
`DynamoDBAction`	`withOperation(String operation)` The type of operation to perform.
`DynamoDBAction`	`withPayload(Payload payload)`
`DynamoDBAction`	`withPayloadField(String payloadField)` The name of the DynamoDB column that receives the action payload.
`DynamoDBAction`	`withRangeKeyField(String rangeKeyField)` The name of the range key (also called the sort key).
`DynamoDBAction`	`withRangeKeyType(String rangeKeyType)` The data type for the range key (also called the sort key), You can specify the following values:
`DynamoDBAction`	`withRangeKeyValue(String rangeKeyValue)` The value of the range key (also called the sort key).
`DynamoDBAction`	`withTableName(String tableName)` The name of the DynamoDB table.

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

- Constructor Detail
  - DynamoDBAction
```
public DynamoDBAction()
```
- Method Detail
  - setHashKeyType
```
public void setHashKeyType(String hashKeyType)
```
    The data type for the hash key (also called the partition key). You can specify the following values:
    - STRING - The hash key is a string.
    - NUMBER - The hash key is a number.
    If you don't specify hashKeyType, the default value is STRING.
    Parameters:
    hashKeyType - The data type for the hash key (also called the partition key). You can specify the following values:
    
    STRING - The hash key is a string.
    
    NUMBER - The hash key is a number.
    
    If you don't specify hashKeyType, the default value is STRING.
  - getHashKeyType
```
public String getHashKeyType()
```
    The data type for the hash key (also called the partition key). You can specify the following values:
    - STRING - The hash key is a string.
    - NUMBER - The hash key is a number.
    If you don't specify hashKeyType, the default value is STRING.
    Returns:
    The data type for the hash key (also called the partition key). You can specify the following values:
    
    STRING - The hash key is a string.
    
    NUMBER - The hash key is a number.
    
    If you don't specify hashKeyType, the default value is STRING.
  - withHashKeyType
```
public DynamoDBAction withHashKeyType(String hashKeyType)
```
    The data type for the hash key (also called the partition key). You can specify the following values:
    - STRING - The hash key is a string.
    - NUMBER - The hash key is a number.
    If you don't specify hashKeyType, the default value is STRING.
    Parameters:
    hashKeyType - The data type for the hash key (also called the partition key). You can specify the following values:
    
    STRING - The hash key is a string.
    
    NUMBER - The hash key is a number.
    
    If you don't specify hashKeyType, the default value is STRING.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHashKeyField
```
public void setHashKeyField(String hashKeyField)
```
    The name of the hash key (also called the partition key).
    
    Parameters:
    
    hashKeyField - The name of the hash key (also called the partition key).
  - getHashKeyField
```
public String getHashKeyField()
```
    The name of the hash key (also called the partition key).
    
    Returns:
    
    The name of the hash key (also called the partition key).
  - withHashKeyField
```
public DynamoDBAction withHashKeyField(String hashKeyField)
```
    The name of the hash key (also called the partition key).
    
    Parameters:
    
    hashKeyField - The name of the hash key (also called the partition key).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHashKeyValue
```
public void setHashKeyValue(String hashKeyValue)
```
    The value of the hash key (also called the partition key).
    
    Parameters:
    
    hashKeyValue - The value of the hash key (also called the partition key).
  - getHashKeyValue
```
public String getHashKeyValue()
```
    The value of the hash key (also called the partition key).
    
    Returns:
    
    The value of the hash key (also called the partition key).
  - withHashKeyValue
```
public DynamoDBAction withHashKeyValue(String hashKeyValue)
```
    The value of the hash key (also called the partition key).
    
    Parameters:
    
    hashKeyValue - The value of the hash key (also called the partition key).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRangeKeyType
```
public void setRangeKeyType(String rangeKeyType)
```
    The data type for the range key (also called the sort key), You can specify the following values:
    - STRING - The range key is a string.
    - NUMBER - The range key is number.
    If you don't specify rangeKeyField, the default value is STRING.
    Parameters:
    rangeKeyType - The data type for the range key (also called the sort key), You can specify the following values:
    
    STRING - The range key is a string.
    
    NUMBER - The range key is number.
    
    If you don't specify rangeKeyField, the default value is STRING.
  - getRangeKeyType
```
public String getRangeKeyType()
```
    The data type for the range key (also called the sort key), You can specify the following values:
    - STRING - The range key is a string.
    - NUMBER - The range key is number.
    If you don't specify rangeKeyField, the default value is STRING.
    Returns:
    The data type for the range key (also called the sort key), You can specify the following values:
    
    STRING - The range key is a string.
    
    NUMBER - The range key is number.
    
    If you don't specify rangeKeyField, the default value is STRING.
  - withRangeKeyType
```
public DynamoDBAction withRangeKeyType(String rangeKeyType)
```
    The data type for the range key (also called the sort key), You can specify the following values:
    - STRING - The range key is a string.
    - NUMBER - The range key is number.
    If you don't specify rangeKeyField, the default value is STRING.
    Parameters:
    rangeKeyType - The data type for the range key (also called the sort key), You can specify the following values:
    
    STRING - The range key is a string.
    
    NUMBER - The range key is number.
    
    If you don't specify rangeKeyField, the default value is STRING.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRangeKeyField
```
public void setRangeKeyField(String rangeKeyField)
```
    The name of the range key (also called the sort key).
    
    Parameters:
    
    rangeKeyField - The name of the range key (also called the sort key).
  - getRangeKeyField
```
public String getRangeKeyField()
```
    The name of the range key (also called the sort key).
    
    Returns:
    
    The name of the range key (also called the sort key).
  - withRangeKeyField
```
public DynamoDBAction withRangeKeyField(String rangeKeyField)
```
    The name of the range key (also called the sort key).
    
    Parameters:
    
    rangeKeyField - The name of the range key (also called the sort key).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRangeKeyValue
```
public void setRangeKeyValue(String rangeKeyValue)
```
    The value of the range key (also called the sort key).
    
    Parameters:
    
    rangeKeyValue - The value of the range key (also called the sort key).
  - getRangeKeyValue
```
public String getRangeKeyValue()
```
    The value of the range key (also called the sort key).
    
    Returns:
    
    The value of the range key (also called the sort key).
  - withRangeKeyValue
```
public DynamoDBAction withRangeKeyValue(String rangeKeyValue)
```
    The value of the range key (also called the sort key).
    
    Parameters:
    
    rangeKeyValue - The value of the range key (also called the sort key).
    
    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 perform. You can specify the following values:
    - INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
    - UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    - DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
    Parameters:
    operation - The type of operation to perform. You can specify the following values:
    
    INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
    
    UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    
    DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    
    If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
  - getOperation
```
public String getOperation()
```
    The type of operation to perform. You can specify the following values:
    - INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
    - UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    - DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
    Returns:
    The type of operation to perform. You can specify the following values:
    
    INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
    
    UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    
    DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    
    If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
  - withOperation
```
public DynamoDBAction withOperation(String operation)
```
    The type of operation to perform. You can specify the following values:
    - INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
    - UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    - DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
    Parameters:
    operation - The type of operation to perform. You can specify the following values:
    
    INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
    
    UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    
    DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
    
    If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPayloadField
```
public void setPayloadField(String payloadField)
```
    The name of the DynamoDB column that receives the action payload.
    
    If you don't specify this parameter, the name of the DynamoDB column is payload.
    
    Parameters:
    
    payloadField - The name of the DynamoDB column that receives the action payload.
    
    If you don't specify this parameter, the name of the DynamoDB column is payload.
  - getPayloadField
```
public String getPayloadField()
```
    The name of the DynamoDB column that receives the action payload.
    
    If you don't specify this parameter, the name of the DynamoDB column is payload.
    
    Returns:
    
    The name of the DynamoDB column that receives the action payload.
    
    If you don't specify this parameter, the name of the DynamoDB column is payload.
  - withPayloadField
```
public DynamoDBAction withPayloadField(String payloadField)
```
    The name of the DynamoDB column that receives the action payload.
    
    If you don't specify this parameter, the name of the DynamoDB column is payload.
    
    Parameters:
    
    payloadField - The name of the DynamoDB column that receives the action payload.
    
    If you don't specify this parameter, the name of the DynamoDB column is payload.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - setPayload
```
public void setPayload(Payload payload)
```
    Parameters:
    
    payload -
  - getPayload
```
public Payload getPayload()
```
    Returns:
  - withPayload
```
public DynamoDBAction withPayload(Payload payload)
```
    Parameters:
    
    payload -
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class DynamoDBAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DynamoDBAction

Method Detail

setHashKeyType

getHashKeyType

withHashKeyType

setHashKeyField

getHashKeyField

withHashKeyField

setHashKeyValue

getHashKeyValue

withHashKeyValue

setRangeKeyType

getRangeKeyType

withRangeKeyType

setRangeKeyField

getRangeKeyField

withRangeKeyField

setRangeKeyValue

getRangeKeyValue

withRangeKeyValue

setOperation

getOperation

withOperation

setPayloadField

getPayloadField

withPayloadField

setTableName

getTableName

withTableName

setPayload

getPayload

withPayload

toString

equals

hashCode

clone

marshall