Class UpdateItemOperation<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.operations.UpdateItemOperation<T>

All Implemented Interfaces:

CommonOperation<T,UpdateItemRequest,UpdateItemResponse,UpdateItemEnhancedResponse<T>>, TableOperation<T,UpdateItemRequest,UpdateItemResponse,UpdateItemEnhancedResponse<T>>, TransactableWriteOperation<T>

public class UpdateItemOperation<T>
extends Object
implements TableOperation<T,UpdateItemRequest,UpdateItemResponse,UpdateItemEnhancedResponse<T>>, TransactableWriteOperation<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NESTED_OBJECT_UPDATE

Method Summary

Modifier and Type	Method	Description
Function<UpdateItemRequest,CompletableFuture<UpdateItemResponse>>	asyncServiceCall(DynamoDbAsyncClient dynamoDbAsyncClient)	Provides a function for making the low level non-blocking asynchronous SDK call to DynamoDb.
static <T> UpdateItemOperation<T>	create(TransactUpdateItemEnhancedRequest<T> request)
static <T> UpdateItemOperation<T>	create(UpdateItemEnhancedRequest<T> request)
UpdateItemRequest	generateRequest(TableSchema<T> tableSchema, OperationContext operationContext, DynamoDbEnhancedClientExtension extension)	This method generates the request that needs to be sent to a low level DynamoDbClient.
TransactWriteItem	generateTransactWriteItem(TableSchema<T> tableSchema, OperationContext operationContext, DynamoDbEnhancedClientExtension dynamoDbEnhancedClientExtension)
OperationName	operationName()	The type, or name, of the operation.
Function<UpdateItemRequest,UpdateItemResponse>	serviceCall(DynamoDbClient dynamoDbClient)	Provides a function for making the low level synchronous SDK call to DynamoDb.
Map<String,AttributeValue>	transformItemToMapForUpdateExpression(Map<String,AttributeValue> itemToMap)	Method checks if a nested object parameter requires an update If so flattens out nested params separated by "_NESTED_ATTR_UPDATE_" this is consumed by @link EnhancedClientUtils to form the appropriate UpdateExpression
UpdateItemEnhancedResponse<T>	transformResponse(UpdateItemResponse response, TableSchema<T> tableSchema, OperationContext operationContext, DynamoDbEnhancedClientExtension extension)	Takes the response object returned by the actual DynamoDb call and maps it into a higher level abstracted result object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.enhanced.dynamodb.internal.operations.CommonOperation

execute, executeAsync

Methods inherited from interface software.amazon.awssdk.enhanced.dynamodb.internal.operations.TableOperation

executeOnPrimaryIndex, executeOnPrimaryIndexAsync

Field Details

NESTED_OBJECT_UPDATE

public static final String NESTED_OBJECT_UPDATE

See Also:

• Constant Field Values

Method Details

create

public static <T> UpdateItemOperation<T> create(UpdateItemEnhancedRequest<T> request)

create

public static <T> UpdateItemOperation<T> create(TransactUpdateItemEnhancedRequest<T> request)

operationName

public OperationName operationName()

Description copied from interface: CommonOperation

The type, or name, of the operation.

Specified by:

operationName in interface CommonOperation<T,UpdateItemRequest,UpdateItemResponse,UpdateItemEnhancedResponse<T>>

generateRequest

public UpdateItemRequest generateRequest(TableSchema<T> tableSchema,
 OperationContext operationContext,
 DynamoDbEnhancedClientExtension extension)

Description copied from interface: CommonOperation

This method generates the request that needs to be sent to a low level DynamoDbClient.

Specified by:

generateRequest in interface CommonOperation<T,UpdateItemRequest,UpdateItemResponse,UpdateItemEnhancedResponse<T>>

Parameters:

tableSchema - A TableSchema that maps the table to a modelled object.

operationContext - An object containing the context, or target, of the command execution.

extension - A DynamoDbEnhancedClientExtension that may modify the request of this operation. A null value here will result in no modifications.

Returns:

A request that can be used as an argument to a DynamoDbClient call to perform the operation.

transformItemToMapForUpdateExpression

public Map<String,AttributeValue> transformItemToMapForUpdateExpression(Map<String,AttributeValue> itemToMap)

Method checks if a nested object parameter requires an update If so flattens out nested params separated by "_NESTED_ATTR_UPDATE_" this is consumed by @link EnhancedClientUtils to form the appropriate UpdateExpression

transformResponse

public UpdateItemEnhancedResponse<T> transformResponse(UpdateItemResponse response,
 TableSchema<T> tableSchema,
 OperationContext operationContext,
 DynamoDbEnhancedClientExtension extension)

Description copied from interface: CommonOperation

Takes the response object returned by the actual DynamoDb call and maps it into a higher level abstracted result object.

Specified by:

transformResponse in interface CommonOperation<T,UpdateItemRequest,UpdateItemResponse,UpdateItemEnhancedResponse<T>>

Parameters:

response - The response object returned by the DynamoDb call for this operation.

tableSchema - A TableSchema that maps the table to a modelled object.

operationContext - An object containing the context, or target, of the command execution.

extension - A DynamoDbEnhancedClientExtension that may modify the result of this operation. A null value here will result in no modifications.

Returns:

A high level result object as specified by the implementation of this operation.

serviceCall

public Function<UpdateItemRequest,UpdateItemResponse> serviceCall(DynamoDbClient dynamoDbClient)

Description copied from interface: CommonOperation

Provides a function for making the low level synchronous SDK call to DynamoDb.

Specified by:

serviceCall in interface CommonOperation<T,UpdateItemRequest,UpdateItemResponse,UpdateItemEnhancedResponse<T>>

Parameters:

dynamoDbClient - A low level DynamoDbClient to make the call against.

Returns:

A function that calls DynamoDb with a provided request object and returns the response object.

asyncServiceCall

public Function<UpdateItemRequest,CompletableFuture<UpdateItemResponse>> asyncServiceCall(DynamoDbAsyncClient dynamoDbAsyncClient)

Description copied from interface: CommonOperation

Provides a function for making the low level non-blocking asynchronous SDK call to DynamoDb.

Specified by:

asyncServiceCall in interface CommonOperation<T,UpdateItemRequest,UpdateItemResponse,UpdateItemEnhancedResponse<T>>

Parameters:

dynamoDbAsyncClient - A low level DynamoDbAsyncClient to make the call against.

Returns:

A function that calls DynamoDb with a provided request object and returns the response object.

generateTransactWriteItem

public TransactWriteItem generateTransactWriteItem(TableSchema<T> tableSchema,
 OperationContext operationContext,
 DynamoDbEnhancedClientExtension dynamoDbEnhancedClientExtension)

Specified by:

generateTransactWriteItem in interface TransactableWriteOperation<T>