software.amazon.awssdk.enhanced.dynamodb.model

Class DeleteItemEnhancedRequest.Builder

java.lang.Object

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

Enclosing class:

DeleteItemEnhancedRequest

@NotThreadSafe
public static final class DeleteItemEnhancedRequest.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
DeleteItemEnhancedRequest	build()
DeleteItemEnhancedRequest.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.
DeleteItemEnhancedRequest.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.
DeleteItemEnhancedRequest.Builder	key(Key key) Sets the primary Key that will be used to match the item to delete.
DeleteItemEnhancedRequest.Builder	returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) Whether to return the capacity consumed by this operation.
DeleteItemEnhancedRequest.Builder	returnConsumedCapacity(String returnConsumedCapacity) Whether to return the capacity consumed by this operation.
DeleteItemEnhancedRequest.Builder	returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) Whether to return the item collection metrics.
DeleteItemEnhancedRequest.Builder	returnItemCollectionMetrics(String returnItemCollectionMetrics) Whether to return the item collection metrics.

Methods inherited from class java.lang.Object

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

Method Detail

key

public DeleteItemEnhancedRequest.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 DeleteItemEnhancedRequest.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 DeleteItemEnhancedRequest.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

returnConsumedCapacity

public DeleteItemEnhancedRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Whether to return the capacity consumed by this operation.

See Also:

DeleteItemRequest.Builder#returnConsumedCapacity(ReturnConsumedCapacity)

returnConsumedCapacity

public DeleteItemEnhancedRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)

Whether to return the capacity consumed by this operation.

See Also:

DeleteItemRequest.Builder#returnConsumedCapacity(String)

returnItemCollectionMetrics

public DeleteItemEnhancedRequest.Builder returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

Whether to return the item collection metrics.

See Also:

DeleteItemRequest.Builder#returnItemCollectionMetrics(ReturnItemCollectionMetrics)

returnItemCollectionMetrics

public DeleteItemEnhancedRequest.Builder returnItemCollectionMetrics(String returnItemCollectionMetrics)

Whether to return the item collection metrics.

See Also:

DeleteItemRequest.Builder#returnItemCollectionMetrics(String)

build

public DeleteItemEnhancedRequest build()