com.amazonaws.services.dynamodbv2.datamodeling

Class TransactionWriteRequest

java.lang.Object

com.amazonaws.services.dynamodbv2.datamodeling.TransactionWriteRequest

@NotThreadSafe
public class TransactionWriteRequest
extends Object

Represents objects to write using AbstractDynamoDBMapper.transactionWrite(TransactionWriteRequest) operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransactionWriteRequest.TransactionWriteOperation Represents a write operation to be executed on an object as part of a transactional write request.
static class	TransactionWriteRequest.TransactionWriteOperationType Operation type for transactional write operations.

Constructor Summary

Constructors

Constructor and Description
TransactionWriteRequest()

Method Summary

Modifier and Type	Method and Description
TransactionWriteRequest	addConditionCheck(Object key, DynamoDBTransactionWriteExpression transactionWriteExpression) Adds conditionCheck operation (to be executed on the object represented by key) to the list of transaction write operations.
TransactionWriteRequest	addConditionCheck(Object key, DynamoDBTransactionWriteExpression transactionWriteExpression, ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) Adds conditionCheck operation (to be executed on the object represented by key) to the list of transaction write operations.
TransactionWriteRequest	addDelete(Object key) Adds delete operation (to be executed on the object represented by key) to the list of transaction write operations.
TransactionWriteRequest	addDelete(Object key, DynamoDBTransactionWriteExpression transactionWriteExpression) Adds delete operation (to be executed on the object represented by key) to the list of transaction write operations.
TransactionWriteRequest	addDelete(Object key, DynamoDBTransactionWriteExpression transactionWriteExpression, ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) Adds delete operation (to be executed on the object represented by key) to the list of transaction write operations.
TransactionWriteRequest	addPut(Object object) Adds put operation (to be executed on object) to the list of transaction write operations.
TransactionWriteRequest	addPut(Object object, DynamoDBTransactionWriteExpression transactionWriteExpression) Adds put operation (to be executed on object) to the list of transaction write operations.
TransactionWriteRequest	addPut(Object object, DynamoDBTransactionWriteExpression transactionWriteExpression, ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) Adds put operation (to be executed on object) to the list of transaction write operations.
TransactionWriteRequest	addUpdate(Object object) Adds update operation (to be executed on object) to the list of transaction write operations.
TransactionWriteRequest	addUpdate(Object object, DynamoDBTransactionWriteExpression transactionWriteExpression) Adds update operation (to be executed on object) to the list of transaction write operations.
TransactionWriteRequest	addUpdate(Object object, DynamoDBTransactionWriteExpression transactionWriteExpression, ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) Adds update operation (to be executed on object) to the list of transaction write operations.
String	getIdempotencyToken() Token used to support idempotency on server side.
List<TransactionWriteRequest.TransactionWriteOperation>	getTransactionWriteOperations() List of TransactionWriteOperations to be executed as part of this transactional write request.
TransactionWriteRequest	withIdempotencyToken(String idempotencyToken) Token used to support idempotency on server side.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionWriteRequest

public TransactionWriteRequest()

Method Detail

addPut

public TransactionWriteRequest addPut(Object object)

Adds put operation (to be executed on object) to the list of transaction write operations. If the corresponding item exists, it will be overwritten.

addPut

public TransactionWriteRequest addPut(Object object,
                                      DynamoDBTransactionWriteExpression transactionWriteExpression)

Adds put operation (to be executed on object) to the list of transaction write operations. transactionWriteExpression is used to conditionally put object.

addPut

public TransactionWriteRequest addPut(Object object,
                                      DynamoDBTransactionWriteExpression transactionWriteExpression,
                                      ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)

Adds put operation (to be executed on object) to the list of transaction write operations. transactionWriteExpression is used to conditionally put object. returnValuesOnConditionCheckFailure specifies which attributes values (of existing item) should be returned if condition check fails.

addUpdate

public TransactionWriteRequest addUpdate(Object object)

Adds update operation (to be executed on object) to the list of transaction write operations.

addUpdate

public TransactionWriteRequest addUpdate(Object object,
                                         DynamoDBTransactionWriteExpression transactionWriteExpression)

Adds update operation (to be executed on object) to the list of transaction write operations. transactionWriteExpression is used to conditionally update object.

addUpdate

public TransactionWriteRequest addUpdate(Object object,
                                         DynamoDBTransactionWriteExpression transactionWriteExpression,
                                         ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)

Adds update operation (to be executed on object) to the list of transaction write operations. transactionWriteExpression is used to conditionally update object. returnValuesOnConditionCheckFailure specifies which attributes values (of existing item) should be returned if condition check fails.

addDelete

public TransactionWriteRequest addDelete(Object key)

Adds delete operation (to be executed on the object represented by key) to the list of transaction write operations.

addDelete

public TransactionWriteRequest addDelete(Object key,
                                         DynamoDBTransactionWriteExpression transactionWriteExpression)

Adds delete operation (to be executed on the object represented by key) to the list of transaction write operations. transactionWriteExpression is used to conditionally delete the object represented by key.

addDelete

public TransactionWriteRequest addDelete(Object key,
                                         DynamoDBTransactionWriteExpression transactionWriteExpression,
                                         ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)

Adds delete operation (to be executed on the object represented by key) to the list of transaction write operations. transactionWriteExpression is used to conditionally delete the object represented by key. returnValuesOnConditionCheckFailure specifies which attributes values (of existing item) should be returned if condition check fails.

addConditionCheck

public TransactionWriteRequest addConditionCheck(Object key,
                                                 DynamoDBTransactionWriteExpression transactionWriteExpression)

Adds conditionCheck operation (to be executed on the object represented by key) to the list of transaction write operations. transactionWriteExpression is used to condition check on the object represented by key.

addConditionCheck

public TransactionWriteRequest addConditionCheck(Object key,
                                                 DynamoDBTransactionWriteExpression transactionWriteExpression,
                                                 ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)

Adds conditionCheck operation (to be executed on the object represented by key) to the list of transaction write operations. transactionWriteExpression is used to condition check on the object represented by key. returnValuesOnConditionCheckFailure specifies which attributes values (of existing item) should be returned if condition check fails.

withIdempotencyToken

public TransactionWriteRequest withIdempotencyToken(String idempotencyToken)

Token used to support idempotency on server side. For more information, please refer: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html

getTransactionWriteOperations

public List<TransactionWriteRequest.TransactionWriteOperation> getTransactionWriteOperations()

List of TransactionWriteOperations to be executed as part of this transactional write request.

getIdempotencyToken

public String getIdempotencyToken()

Token used to support idempotency on server side.