DynamoDBAction.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<DynamoDBAction.Builder,DynamoDBAction>, SdkBuilder<DynamoDBAction.Builder,DynamoDBAction>, SdkPojo

Enclosing class:

DynamoDBAction
```
public static interface DynamoDBAction.Builder
extends SdkPojo, CopyableBuilder<DynamoDBAction.Builder,DynamoDBAction>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DynamoDBAction.Builder`	`hashKeyField(String hashKeyField)` The name of the hash key (also called the partition key).
`DynamoDBAction.Builder`	`hashKeyType(String hashKeyType)` The data type for the hash key (also called the partition key).
`DynamoDBAction.Builder`	`hashKeyValue(String hashKeyValue)` The value of the hash key (also called the partition key).
`DynamoDBAction.Builder`	`operation(String operation)` The type of operation to perform.
`default DynamoDBAction.Builder`	`payload(Consumer<Payload.Builder> payload)` Sets the value of the Payload property for this object.
`DynamoDBAction.Builder`	`payload(Payload payload)` Sets the value of the Payload property for this object.
`DynamoDBAction.Builder`	`payloadField(String payloadField)` The name of the DynamoDB column that receives the action payload.
`DynamoDBAction.Builder`	`rangeKeyField(String rangeKeyField)` The name of the range key (also called the sort key).
`DynamoDBAction.Builder`	`rangeKeyType(String rangeKeyType)` The data type for the range key (also called the sort key), You can specify the following values:
`DynamoDBAction.Builder`	`rangeKeyValue(String rangeKeyValue)` The value of the range key (also called the sort key).
`DynamoDBAction.Builder`	`tableName(String tableName)` The name of the DynamoDB table.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - hashKeyType
```
DynamoDBAction.Builder hashKeyType(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.
  - hashKeyField
```
DynamoDBAction.Builder hashKeyField(String hashKeyField)
```
    The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.
    
    Parameters:
    
    hashKeyField - The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - hashKeyValue
```
DynamoDBAction.Builder hashKeyValue(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.
  - rangeKeyType
```
DynamoDBAction.Builder rangeKeyType(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.
  - rangeKeyField
```
DynamoDBAction.Builder rangeKeyField(String rangeKeyField)
```
    The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.
    
    Parameters:
    
    rangeKeyField - The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - rangeKeyValue
```
DynamoDBAction.Builder rangeKeyValue(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.
  - operation
```
DynamoDBAction.Builder operation(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.
  - payloadField
```
DynamoDBAction.Builder payloadField(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.
  - tableName
```
DynamoDBAction.Builder tableName(String tableName)
```
    The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table.
    
    Parameters:
    
    tableName - The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - payload
```
DynamoDBAction.Builder payload(Payload payload)
```
    Sets the value of the Payload property for this object.
    
    Parameters:
    
    payload - The new value for the Payload property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - payload
```
default DynamoDBAction.Builder payload(Consumer<Payload.Builder> payload)
```
    Sets the value of the Payload property for this object. This is a convenience that creates an instance of the Payload.Builder avoiding the need to create one manually via Payload.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to payload(Payload).
    
    Parameters:
    
    payload - a consumer that will call methods on Payload.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    payload(Payload)

Interface DynamoDBAction.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

hashKeyType

hashKeyField

hashKeyValue

rangeKeyType

rangeKeyField

rangeKeyValue

operation

payloadField

tableName

payload

payload