@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()}"
Constructor and Description |
---|
DynamoDBAction() |
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.
|
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.
|
public void setTableName(String tableName)
The name of the DynamoDB table.
tableName
- The name of the DynamoDB table.public String getTableName()
The name of the DynamoDB table.
public DynamoDBAction withTableName(String tableName)
The name of the DynamoDB table.
tableName
- The name of the DynamoDB table.public void setRoleArn(String roleArn)
The ARN of the IAM role that grants access to the DynamoDB table.
roleArn
- The ARN of the IAM role that grants access to the DynamoDB table.public String getRoleArn()
The ARN of the IAM role that grants access to the DynamoDB table.
public DynamoDBAction withRoleArn(String roleArn)
The ARN of the IAM role that grants access to the DynamoDB table.
roleArn
- The ARN of the IAM role that grants access to the DynamoDB table.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
.
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
.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
.
${operation}
, but the substitution must result in one of the following: INSERT
,
UPDATE
, or DELETE
.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
.
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
.public void setHashKeyField(String hashKeyField)
The hash key name.
hashKeyField
- The hash key name.public String getHashKeyField()
The hash key name.
public DynamoDBAction withHashKeyField(String hashKeyField)
The hash key name.
hashKeyField
- The hash key name.public void setHashKeyValue(String hashKeyValue)
The hash key value.
hashKeyValue
- The hash key value.public String getHashKeyValue()
The hash key value.
public DynamoDBAction withHashKeyValue(String hashKeyValue)
The hash key value.
hashKeyValue
- The hash key value.public void setHashKeyType(String hashKeyType)
The hash key type. Valid values are "STRING" or "NUMBER"
hashKeyType
- The hash key type. Valid values are "STRING" or "NUMBER"DynamoKeyType
public String getHashKeyType()
The hash key type. Valid values are "STRING" or "NUMBER"
DynamoKeyType
public DynamoDBAction withHashKeyType(String hashKeyType)
The hash key type. Valid values are "STRING" or "NUMBER"
hashKeyType
- The hash key type. Valid values are "STRING" or "NUMBER"DynamoKeyType
public void setHashKeyType(DynamoKeyType hashKeyType)
The hash key type. Valid values are "STRING" or "NUMBER"
hashKeyType
- The hash key type. Valid values are "STRING" or "NUMBER"DynamoKeyType
public DynamoDBAction withHashKeyType(DynamoKeyType hashKeyType)
The hash key type. Valid values are "STRING" or "NUMBER"
hashKeyType
- The hash key type. Valid values are "STRING" or "NUMBER"DynamoKeyType
public void setRangeKeyField(String rangeKeyField)
The range key name.
rangeKeyField
- The range key name.public String getRangeKeyField()
The range key name.
public DynamoDBAction withRangeKeyField(String rangeKeyField)
The range key name.
rangeKeyField
- The range key name.public void setRangeKeyValue(String rangeKeyValue)
The range key value.
rangeKeyValue
- The range key value.public String getRangeKeyValue()
The range key value.
public DynamoDBAction withRangeKeyValue(String rangeKeyValue)
The range key value.
rangeKeyValue
- The range key value.public void setRangeKeyType(String rangeKeyType)
The range key type. Valid values are "STRING" or "NUMBER"
rangeKeyType
- The range key type. Valid values are "STRING" or "NUMBER"DynamoKeyType
public String getRangeKeyType()
The range key type. Valid values are "STRING" or "NUMBER"
DynamoKeyType
public DynamoDBAction withRangeKeyType(String rangeKeyType)
The range key type. Valid values are "STRING" or "NUMBER"
rangeKeyType
- The range key type. Valid values are "STRING" or "NUMBER"DynamoKeyType
public void setRangeKeyType(DynamoKeyType rangeKeyType)
The range key type. Valid values are "STRING" or "NUMBER"
rangeKeyType
- The range key type. Valid values are "STRING" or "NUMBER"DynamoKeyType
public DynamoDBAction withRangeKeyType(DynamoKeyType rangeKeyType)
The range key type. Valid values are "STRING" or "NUMBER"
rangeKeyType
- The range key type. Valid values are "STRING" or "NUMBER"DynamoKeyType
public void setPayloadField(String payloadField)
The action payload. This name can be customized.
payloadField
- The action payload. This name can be customized.public String getPayloadField()
The action payload. This name can be customized.
public DynamoDBAction withPayloadField(String payloadField)
The action payload. This name can be customized.
payloadField
- The action payload. This name can be customized.public String toString()
toString
in class Object
Object.toString()
public DynamoDBAction clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.