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

Class TransactWriteItemsEnhancedRequest.Builder

java.lang.Object

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

Enclosing class:

TransactWriteItemsEnhancedRequest

@NotThreadSafe
public static final class TransactWriteItemsEnhancedRequest.Builder
extends Object

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

A valid builder should contain at least one low-level request such as DeleteItemEnhancedRequest.

Method Summary

Modifier and Type	Method	Description
<T> TransactWriteItemsEnhancedRequest.Builder	addConditionCheck(MappedTableResource<T> mappedTableResource, Consumer<ConditionCheck.Builder> requestConsumer)	Adds a condition check for a primary key in the associated table to the transaction by accepting a consumer of ConditionCheck.Builder.
<T> TransactWriteItemsEnhancedRequest.Builder	addConditionCheck(MappedTableResource<T> mappedTableResource, ConditionCheck<T> request)	Adds a condition check for a primary key in the associated table to the transaction.
<T> TransactWriteItemsEnhancedRequest.Builder	addDeleteItem(MappedTableResource<T> mappedTableResource, Key key)	Adds a primary lookup key for the item to delete, and it's associated table, to the transaction.
<T> TransactWriteItemsEnhancedRequest.Builder	addDeleteItem(MappedTableResource<T> mappedTableResource, DeleteItemEnhancedRequest request)	Deprecated. Use addDeleteItem(MappedTableResource, TransactDeleteItemEnhancedRequest)
<T> TransactWriteItemsEnhancedRequest.Builder	addDeleteItem(MappedTableResource<T> mappedTableResource, TransactDeleteItemEnhancedRequest request)	Adds a primary lookup key for the item to delete, and its associated table, to the transaction.
<T> TransactWriteItemsEnhancedRequest.Builder	addDeleteItem(MappedTableResource<T> mappedTableResource, T keyItem)	Adds a primary lookup key for the item to delete, and it's associated table, to the transaction.
<T> TransactWriteItemsEnhancedRequest.Builder	addPutItem(MappedTableResource<T> mappedTableResource, PutItemEnhancedRequest<T> request)	Deprecated. Use addPutItem(MappedTableResource, TransactPutItemEnhancedRequest)
<T> TransactWriteItemsEnhancedRequest.Builder	addPutItem(MappedTableResource<T> mappedTableResource, TransactPutItemEnhancedRequest<T> request)	Adds an item to be written, and it's associated table, to the transaction.
<T> TransactWriteItemsEnhancedRequest.Builder	addPutItem(MappedTableResource<T> mappedTableResource, T item)	Adds an item to be written, and it's associated table, to the transaction.
<T> TransactWriteItemsEnhancedRequest.Builder	addUpdateItem(MappedTableResource<T> mappedTableResource, TransactUpdateItemEnhancedRequest<T> request)	Adds an item to be updated, and it's associated table, to the transaction.
<T> TransactWriteItemsEnhancedRequest.Builder	addUpdateItem(MappedTableResource<T> mappedTableResource, UpdateItemEnhancedRequest<T> request)	Deprecated. Use addUpdateItem(MappedTableResource, TransactUpdateItemEnhancedRequest)
<T> TransactWriteItemsEnhancedRequest.Builder	addUpdateItem(MappedTableResource<T> mappedTableResource, T item)	Adds an item to be updated, and it's associated table, to the transaction.
TransactWriteItemsEnhancedRequest	build()	Builds a TransactWriteItemsEnhancedRequest from the values stored in this builder.
TransactWriteItemsEnhancedRequest.Builder	clientRequestToken(String clientRequestToken)	Sets the clientRequestToken in this builder.
TransactWriteItemsEnhancedRequest.Builder	returnConsumedCapacity(String returnConsumedCapacity)	Whether to return the capacity consumed by this operation.
TransactWriteItemsEnhancedRequest.Builder	returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)	Whether to return the capacity consumed by this operation.
TransactWriteItemsEnhancedRequest.Builder	returnItemCollectionMetrics(String returnItemCollectionMetrics)	Whether to return the item collection metrics.
TransactWriteItemsEnhancedRequest.Builder	returnItemCollectionMetrics(ReturnItemCollectionMetrics 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

addConditionCheck

public <T> TransactWriteItemsEnhancedRequest.Builder addConditionCheck(MappedTableResource<T> mappedTableResource,
                                                                       ConditionCheck<T> request)

Adds a condition check for a primary key in the associated table to the transaction.

Note: The condition check should be applied to an item that is not modified by another action in the same transaction. See ConditionCheck for more information on how to build a condition check, and the DynamoDb TransactWriteItems documentation for more information on how a condition check affects the transaction.

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table on which to apply the condition check

request - A ConditionCheck definition

Returns:

a builder of this type

addConditionCheck

public <T> TransactWriteItemsEnhancedRequest.Builder addConditionCheck(MappedTableResource<T> mappedTableResource,
                                                                       Consumer<ConditionCheck.Builder> requestConsumer)

Adds a condition check for a primary key in the associated table to the transaction by accepting a consumer of ConditionCheck.Builder.

Note: The condition check should be applied to an item that is not modified by another action in the same transaction. See ConditionCheck for more information on how to build a condition check, and the DynamoDb TransactWriteItems documentation for more information on how a condition check affects the transaction.

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table on which to apply the condition check

requestConsumer - a Consumer of DeleteItemEnhancedRequest

Returns:

a builder of this type

addDeleteItem

@Deprecated
public <T> TransactWriteItemsEnhancedRequest.Builder addDeleteItem(MappedTableResource<T> mappedTableResource,
                                                                   DeleteItemEnhancedRequest request)

Deprecated.

Use addDeleteItem(MappedTableResource, TransactDeleteItemEnhancedRequest)

Adds a primary lookup key for the item to delete, and it's associated table, to the transaction. For more information on the delete action, see the low-level operation description in for instance DynamoDbTable.deleteItem(DeleteItemEnhancedRequest) and how to construct the low-level request in DeleteItemEnhancedRequest.

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table where the key is located

request - A DeleteItemEnhancedRequest

Returns:

a builder of this type

addDeleteItem

public <T> TransactWriteItemsEnhancedRequest.Builder addDeleteItem(MappedTableResource<T> mappedTableResource,
                                                                   TransactDeleteItemEnhancedRequest request)

Adds a primary lookup key for the item to delete, and its associated table, to the transaction. For more information on the delete action, see the low-level operation description in for instance DynamoDbTable.deleteItem(DeleteItemEnhancedRequest) and how to construct the low-level request in TransactDeleteItemEnhancedRequest.

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table where the key is located

request - A TransactDeleteItemEnhancedRequest

Returns:

a builder of this type

addDeleteItem

public <T> TransactWriteItemsEnhancedRequest.Builder addDeleteItem(MappedTableResource<T> mappedTableResource,
                                                                   Key key)

Adds a primary lookup key for the item to delete, and it's associated table, to the transaction. For more information on the delete action, see the low-level operation description in for instance DynamoDbTable.deleteItem(DeleteItemEnhancedRequest).

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table where the key is located

key - a Key that identifies the record to be deleted as part of the transaction.

Returns:

a builder of this type

addDeleteItem

public <T> TransactWriteItemsEnhancedRequest.Builder addDeleteItem(MappedTableResource<T> mappedTableResource,
                                                                   T keyItem)

Adds a primary lookup key for the item to delete, and it's associated table, to the transaction. For more information on the delete action, see the low-level operation description in for instance DynamoDbTable.deleteItem(DeleteItemEnhancedRequest).

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table where the key is located

keyItem - an item that will have its key fields used to match a record to retrieve from the database

Returns:

a builder of this type

addPutItem

@Deprecated
public <T> TransactWriteItemsEnhancedRequest.Builder addPutItem(MappedTableResource<T> mappedTableResource,
                                                                PutItemEnhancedRequest<T> request)

Deprecated.

Use addPutItem(MappedTableResource, TransactPutItemEnhancedRequest)

Adds an item to be written, and it's associated table, to the transaction. For more information on the put action, see the low-level operation description in for instance DynamoDbTable.putItem(PutItemEnhancedRequest) and how to construct the low-level request in PutItemEnhancedRequest.

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table to write the item to

request - A PutItemEnhancedRequest

Returns:

a builder of this type

addPutItem

public <T> TransactWriteItemsEnhancedRequest.Builder addPutItem(MappedTableResource<T> mappedTableResource,
                                                                TransactPutItemEnhancedRequest<T> request)

Adds an item to be written, and it's associated table, to the transaction. For more information on the put action, see the low-level operation description in for instance DynamoDbTable.putItem(PutItemEnhancedRequest) and how to construct the low-level request in TransactPutItemEnhancedRequest.

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table to write the item to

request - A TransactPutItemEnhancedRequest

Returns:

a builder of this type

addPutItem

public <T> TransactWriteItemsEnhancedRequest.Builder addPutItem(MappedTableResource<T> mappedTableResource,
                                                                T item)

Adds an item to be written, and it's associated table, to the transaction. For more information on the put action, see the low-level operation description in for instance DynamoDbTable.putItem(PutItemEnhancedRequest).

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table to write the item to

item - the item to be inserted or overwritten in the database

Returns:

a builder of this type

addUpdateItem

@Deprecated
public <T> TransactWriteItemsEnhancedRequest.Builder addUpdateItem(MappedTableResource<T> mappedTableResource,
                                                                   UpdateItemEnhancedRequest<T> request)

Deprecated.

Use addUpdateItem(MappedTableResource, TransactUpdateItemEnhancedRequest)

Adds an item to be updated, and it's associated table, to the transaction. For more information on the update action, see the low-level operation description in for instance DynamoDbTable.updateItem(UpdateItemEnhancedRequest) and how to construct the low-level request in UpdateItemEnhancedRequest.

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table to write the item to

request - A UpdateItemEnhancedRequest

Returns:

a builder of this type

addUpdateItem

public <T> TransactWriteItemsEnhancedRequest.Builder addUpdateItem(MappedTableResource<T> mappedTableResource,
                                                                   TransactUpdateItemEnhancedRequest<T> request)

Adds an item to be updated, and it's associated table, to the transaction. For more information on the update action, see the low-level operation description in for instance DynamoDbTable.updateItem(UpdateItemEnhancedRequest) and how to construct the low-level request in TransactUpdateItemEnhancedRequest.

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table to write the item to

request - A UpdateItemEnhancedRequest

Returns:

a builder of this type

addUpdateItem

public <T> TransactWriteItemsEnhancedRequest.Builder addUpdateItem(MappedTableResource<T> mappedTableResource,
                                                                   T item)

Adds an item to be updated, and it's associated table, to the transaction. For more information on the update action, see the low-level operation description in for instance DynamoDbTable.updateItem(UpdateItemEnhancedRequest).

Type Parameters:

T - the type of modelled objects in the table

Parameters:

mappedTableResource - the table to write the item to

item - an item to update or insert into the database as part of this transaction

Returns:

a builder of this type

returnConsumedCapacity

public TransactWriteItemsEnhancedRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Whether to return the capacity consumed by this operation.

See Also:

TransactWriteItemsRequest.Builder.returnConsumedCapacity(ReturnConsumedCapacity)

returnConsumedCapacity

public TransactWriteItemsEnhancedRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)

Whether to return the capacity consumed by this operation.

See Also:

TransactWriteItemsRequest.Builder.returnConsumedCapacity(String)

returnItemCollectionMetrics

public TransactWriteItemsEnhancedRequest.Builder returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

Whether to return the item collection metrics.

See Also:

TransactWriteItemsRequest.Builder.returnItemCollectionMetrics(ReturnItemCollectionMetrics)

returnItemCollectionMetrics

public TransactWriteItemsEnhancedRequest.Builder returnItemCollectionMetrics(String returnItemCollectionMetrics)

Whether to return the item collection metrics.

See Also:

UpdateItemRequest.Builder.returnItemCollectionMetrics(String)

clientRequestToken

public TransactWriteItemsEnhancedRequest.Builder clientRequestToken(String clientRequestToken)

Sets the clientRequestToken in this builder.

Parameters:

clientRequestToken - the clientRequestToken going to be used for build

Returns:

a builder of this type

build

public TransactWriteItemsEnhancedRequest build()

Builds a TransactWriteItemsEnhancedRequest from the values stored in this builder.