software.amazon.awssdk.enhanced.dynamodb.model

Class TransactDeleteItemEnhancedRequest.Builder

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.TransactDeleteItemEnhancedRequest.Builder

Enclosing class:

TransactDeleteItemEnhancedRequest

@NotThreadSafe
public static final class TransactDeleteItemEnhancedRequest.Builder
extends Object

A builder that is used to create a request with the desired parameters.

Note: A valid request builder must define a Key.

Method Summary

Modifier and Type	Method and Description
TransactDeleteItemEnhancedRequest	build()
TransactDeleteItemEnhancedRequest.Builder	conditionExpression(Expression conditionExpression) Defines a logical expression on an item's attribute values which, if evaluating to true, will allow the delete operation to succeed.
TransactDeleteItemEnhancedRequest.Builder	key(Consumer<Key.Builder> keyConsumer) Sets the primary Key that will be used to match the item to delete on the builder by accepting a consumer of Key.Builder.
TransactDeleteItemEnhancedRequest.Builder	key(Key key) Sets the primary Key that will be used to match the item to delete.
TransactDeleteItemEnhancedRequest.Builder	returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails.
TransactDeleteItemEnhancedRequest.Builder	returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails.

Methods inherited from class java.lang.Object

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

Method Detail

key

public TransactDeleteItemEnhancedRequest.Builder key(Key key)

Sets the primary Key that will be used to match the item to delete.

Parameters:

key - the primary key to use in the request.

Returns:

a builder of this type

key

public TransactDeleteItemEnhancedRequest.Builder key(Consumer<Key.Builder> keyConsumer)

Sets the primary Key that will be used to match the item to delete on the builder by accepting a consumer of Key.Builder.

Parameters:

keyConsumer - a Consumer of Key

Returns:

a builder of this type

conditionExpression

public TransactDeleteItemEnhancedRequest.Builder conditionExpression(Expression conditionExpression)

Defines a logical expression on an item's attribute values which, if evaluating to true, will allow the delete operation to succeed. If evaluating to false, the operation will not succeed.

See Expression for condition syntax and examples.

Parameters:

conditionExpression - a condition written as an Expression

Returns:

a builder of this type

returnValuesOnConditionCheckFailure

public TransactDeleteItemEnhancedRequest.Builder returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

Parameters:

returnValuesOnConditionCheckFailure - What values to return on condition check failure.

Returns:

a builder of this type

returnValuesOnConditionCheckFailure

public TransactDeleteItemEnhancedRequest.Builder returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

Parameters:

returnValuesOnConditionCheckFailure - What values to return on condition check failure.

Returns:

a builder of this type

build

public TransactDeleteItemEnhancedRequest build()