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

Class DeleteItem<T>

java.lang.Object

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

All Implemented Interfaces:

BatchableWriteOperation<T>, CommonOperation<T,DeleteItemRequest,DeleteItemResponse,T>, TableOperation<T,DeleteItemRequest,DeleteItemResponse,T>, TransactableWriteOperation<T>

public class DeleteItem<T>
extends Object
implements TableOperation<T,DeleteItemRequest,DeleteItemResponse,T>, TransactableWriteOperation<T>, BatchableWriteOperation<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeleteItem.Builder

Method Summary

Modifier and Type	Method and Description
Function<DeleteItemRequest,CompletableFuture<DeleteItemResponse>>	asyncServiceCall(DynamoDbAsyncClient dynamoDbAsyncClient) Provides a function for making the low level non-blocking asynchronous SDK call to DynamoDb.
static DeleteItem.Builder	builder()
static <T> DeleteItem<T>	create(Key key)
boolean	equals(Object o)
DeleteItemRequest	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)
WriteRequest	generateWriteRequest(TableSchema<T> tableSchema, OperationContext operationContext, MapperExtension mapperExtension)
int	hashCode()
Key	key()
Function<DeleteItemRequest,DeleteItemResponse>	serviceCall(DynamoDbClient dynamoDbClient) Provides a function for making the low level synchronous SDK call to DynamoDb.
DeleteItem.Builder	toBuilder()
T	transformResponse(DeleteItemResponse 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, executeOnPrimaryIndexAsync

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

execute, executeAsync

Method Detail

create

public static <T> DeleteItem<T> create(Key key)

builder

public static DeleteItem.Builder builder()

toBuilder

public DeleteItem.Builder toBuilder()

generateRequest

public DeleteItemRequest 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,DeleteItemRequest,DeleteItemResponse,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(DeleteItemResponse 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,DeleteItemRequest,DeleteItemResponse,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<DeleteItemRequest,DeleteItemResponse> 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,DeleteItemRequest,DeleteItemResponse,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<DeleteItemRequest,CompletableFuture<DeleteItemResponse>> 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,DeleteItemRequest,DeleteItemResponse,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.

generateWriteRequest

public WriteRequest generateWriteRequest(TableSchema<T> tableSchema,
                                         OperationContext operationContext,
                                         MapperExtension mapperExtension)

Specified by:

generateWriteRequest in interface BatchableWriteOperation<T>

generateTransactWriteItem

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

Specified by:

generateTransactWriteItem in interface TransactableWriteOperation<T>

key

public Key key()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object