software.amazon.awscdk.services.stepfunctions.tasks

Class DynamoDeleteItemProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.DynamoDeleteItemProps.Builder

Enclosing interface:

DynamoDeleteItemProps

@Stability(value=Experimental)
public static final class DynamoDeleteItemProps.Builder
extends Object

A builder for DynamoDeleteItemProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DynamoDeleteItemProps	build() Builds the configured instance.
DynamoDeleteItemProps.Builder	conditionExpression(String conditionExpression) Sets the value of DynamoDeleteItemProps.getConditionExpression()
DynamoDeleteItemProps.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames) Sets the value of DynamoDeleteItemProps.getExpressionAttributeNames()
DynamoDeleteItemProps.Builder	expressionAttributeValues(DynamoAttributeValueMap expressionAttributeValues) Sets the value of DynamoDeleteItemProps.getExpressionAttributeValues()
DynamoDeleteItemProps.Builder	partitionKey(DynamoAttribute partitionKey) Sets the value of DynamoDeleteItemProps.getPartitionKey()
DynamoDeleteItemProps.Builder	returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity) Sets the value of DynamoDeleteItemProps.getReturnConsumedCapacity()
DynamoDeleteItemProps.Builder	returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics) Sets the value of DynamoDeleteItemProps.getReturnItemCollectionMetrics()
DynamoDeleteItemProps.Builder	returnValues(DynamoReturnValues returnValues) Sets the value of DynamoDeleteItemProps.getReturnValues()
DynamoDeleteItemProps.Builder	sortKey(DynamoAttribute sortKey) Sets the value of DynamoDeleteItemProps.getSortKey()
DynamoDeleteItemProps.Builder	tableName(String tableName) Sets the value of DynamoDeleteItemProps.getTableName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

partitionKey

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder partitionKey(DynamoAttribute partitionKey)

Sets the value of DynamoDeleteItemProps.getPartitionKey()

Parameters:

partitionKey - An attribute representing the partition key of the item to delete. This parameter is required.

Returns:

this

tableName

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder tableName(String tableName)

Sets the value of DynamoDeleteItemProps.getTableName()

Parameters:

tableName - The name of the table containing the requested item. This parameter is required.

Returns:

this

conditionExpression

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder conditionExpression(String conditionExpression)

Sets the value of DynamoDeleteItemProps.getConditionExpression()

Parameters:

conditionExpression - A condition that must be satisfied in order for a conditional DeleteItem to succeed.

Returns:

this

expressionAttributeNames

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)

Sets the value of DynamoDeleteItemProps.getExpressionAttributeNames()

Parameters:

expressionAttributeNames - One or more substitution tokens for attribute names in an expression.

Returns:

this

expressionAttributeValues

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder expressionAttributeValues(DynamoAttributeValueMap expressionAttributeValues)

Sets the value of DynamoDeleteItemProps.getExpressionAttributeValues()

Parameters:

expressionAttributeValues - One or more values that can be substituted in an expression.

Returns:

this

returnConsumedCapacity

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)

Sets the value of DynamoDeleteItemProps.getReturnConsumedCapacity()

Parameters:

returnConsumedCapacity - Determines the level of detail about provisioned throughput consumption that is returned in the response.

Returns:

this

returnItemCollectionMetrics

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)

Sets the value of DynamoDeleteItemProps.getReturnItemCollectionMetrics()

Parameters:

returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns:

this

returnValues

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder returnValues(DynamoReturnValues returnValues)

Sets the value of DynamoDeleteItemProps.getReturnValues()

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

Returns:

this

sortKey

@Stability(value=Experimental)
public DynamoDeleteItemProps.Builder sortKey(DynamoAttribute sortKey)

Sets the value of DynamoDeleteItemProps.getSortKey()

Parameters:

sortKey - An attribute representing the sort key of the item to delete.

Returns:

this

build

@Stability(value=Experimental)
public DynamoDeleteItemProps build()

Builds the configured instance.

Returns:

a new instance of DynamoDeleteItemProps

Throws:

NullPointerException - if any required attribute was not provided