software.amazon.awssdk.extensions.dynamodb.mappingclient.operations

Class UpdateItem<T>

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.operations.UpdateItem<T>

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateItem.Builder<T>
static class	UpdateItem.GenericBuilder

Method Summary

Modifier and Type	Method and Description
static UpdateItem.GenericBuilder	builder()
boolean	equals(Object o)
UpdateItemRequest	generateRequest(TableSchema<T> tableSchema, OperationContext operationContext, MapperExtension mapperExtension) This method generates the request that needs to be sent to a low level DynamoDbClient.
TransactWriteItem	generateTransactWriteItem(TableSchema<T> tableSchema, OperationContext operationContext, MapperExtension mapperExtension)
int	hashCode()
Boolean	ignoreNulls()
T	item()
static <T> UpdateItem<T>	of(T item)
Function<UpdateItemRequest,UpdateItemResponse>	serviceCall(DynamoDbClient dynamoDbClient) Provides a function for making the low level SDK call to DynamoDb.
UpdateItem.Builder<T>	toBuilder()
T	transformResponse(UpdateItemResponse response, TableSchema<T> tableSchema, OperationContext operationContext, MapperExtension mapperExtension) 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

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

Methods inherited from interface software.amazon.awssdk.extensions.dynamodb.mappingclient.TableOperation

executeOnPrimaryIndex

Methods inherited from interface software.amazon.awssdk.extensions.dynamodb.mappingclient.CommonOperation

execute

Method Detail

of

public static <T> UpdateItem<T> of(T item)

builder

public static UpdateItem.GenericBuilder builder()

toBuilder

public UpdateItem.Builder<T> toBuilder()

generateRequest

public UpdateItemRequest generateRequest(TableSchema<T> tableSchema,
                                         OperationContext operationContext,
                                         MapperExtension mapperExtension)

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,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.

mapperExtension - A MapperExtension 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.

transformResponse

public T transformResponse(UpdateItemResponse response,
                           TableSchema<T> tableSchema,
                           OperationContext operationContext,
                           MapperExtension mapperExtension)

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,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.

mapperExtension - A MapperExtension 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 SDK call to DynamoDb.

Specified by:

serviceCall in interface CommonOperation<T,UpdateItemRequest,UpdateItemResponse,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.

generateTransactWriteItem

public TransactWriteItem generateTransactWriteItem(TableSchema<T> tableSchema,
                                                   OperationContext operationContext,
                                                   MapperExtension mapperExtension)

Specified by:

generateTransactWriteItem in interface TransactableWriteOperation<T>

item

public T item()

ignoreNulls

public Boolean ignoreNulls()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object