Package software.amazon.awssdk.enhanced.dynamodb.model

Class TransactWriteItemsEnhancedRequest

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.TransactWriteItemsEnhancedRequest

@SdkPublicApi
@ThreadSafe
public final class TransactWriteItemsEnhancedRequest
extends Object

Defines parameters used for the transaction operation transactWriteItems() (such as DynamoDbEnhancedClient.transactWriteItems(TransactWriteItemsEnhancedRequest)).

A request contains parameters for the different actions available in the operation:

• Write/Update items through put and update actions
• Delete items
• Use a condition check

It's populated with one or more low-level requests, such as TransactPutItemEnhancedRequest and each low-level action request is associated with the table where the action should be applied. On initialization, these requests are transformed into TransactWriteItem and stored in the request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransactWriteItemsEnhancedRequest.Builder	A builder that is used to create a transaction object with the desired parameters.

Method Summary

Modifier and Type	Method	Description
static TransactWriteItemsEnhancedRequest.Builder	builder()	Creates a newly initialized builder for a request object.
String	clientRequestToken()	Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.
boolean	equals(Object o)
int	hashCode()
ReturnConsumedCapacity	returnConsumedCapacity()	Whether to return the capacity consumed by this operation.
String	returnConsumedCapacityAsString()	Whether to return the capacity consumed by this operation.
ReturnItemCollectionMetrics	returnItemCollectionMetrics()	Whether to return the item collection metrics.
String	returnItemCollectionMetricsAsString()	Whether to return the item collection metrics.
List<TransactWriteItem>	transactWriteItems()	Returns the list of TransactWriteItem that represents all actions in the request.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static TransactWriteItemsEnhancedRequest.Builder builder()

Creates a newly initialized builder for a request object.

clientRequestToken

public String clientRequestToken()

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

returnConsumedCapacity

public ReturnConsumedCapacity returnConsumedCapacity()

Whether to return the capacity consumed by this operation.

See Also:

PutItemRequest.returnConsumedCapacity()

returnConsumedCapacityAsString

public String returnConsumedCapacityAsString()

Whether to return the capacity consumed by this operation.

Similar to returnConsumedCapacity() but return the value as a string. This is useful in situations where the value is not defined in ReturnConsumedCapacity.

returnItemCollectionMetrics

public ReturnItemCollectionMetrics returnItemCollectionMetrics()

Whether to return the item collection metrics.

See Also:

DeleteItemRequest.returnItemCollectionMetrics()

returnItemCollectionMetricsAsString

public String returnItemCollectionMetricsAsString()

Whether to return the item collection metrics.

Similar to returnConsumedCapacity() but return the value as a string. This is useful in situations where the value is not defined in ReturnConsumedCapacity.

transactWriteItems

public List<TransactWriteItem> transactWriteItems()

Returns the list of TransactWriteItem that represents all actions in the request.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object