software.amazon.awssdk.extensions.dynamodb.mappingclient.model

Class WriteBatch<T>

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.model.WriteBatch<T>

Type Parameters:

T - The type of object this batch applies to. Can be safely erased as it's not needed outside the class itself.

public class WriteBatch<T>
extends Object

Encapsulates a single write batch that can form a list of write batches that go into a BatchWriteItemEnhancedRequest. Example: WriteBatch.create(myTable, putItem.create(myItem)); WriteBatch.create(myTable, deleteItem(Key.of(stringValue("id123"))));

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addWriteRequestsToMap(Map<String,Collection<WriteRequest>> writeRequestMap) This method is used by the internal batchWriteItem operation to generate list of batch write requests used in the call to DynamoDb.
static <T> WriteBatch.Builder<T>	builder()
static <T> WriteBatch<T>	create(MappedTableResource<T> mappedTableResource, BatchableWriteOperation<T>... writeOperations)
static <T> WriteBatch<T>	create(MappedTableResource<T> mappedTableResource, Collection<BatchableWriteOperation<T>> writeOperations)
boolean	equals(Object o)
int	hashCode()
MappedTableResource<T>	mappedTableResource()
WriteBatch.Builder<T>	toBuilder()
Collection<BatchableWriteOperation<T>>	writeOperations()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> WriteBatch<T> create(MappedTableResource<T> mappedTableResource,
                                       Collection<BatchableWriteOperation<T>> writeOperations)

create

@SafeVarargs
public static <T> WriteBatch<T> create(MappedTableResource<T> mappedTableResource,
                                                    BatchableWriteOperation<T>... writeOperations)

builder

public static <T> WriteBatch.Builder<T> builder()

toBuilder

public WriteBatch.Builder<T> toBuilder()

mappedTableResource

public MappedTableResource<T> mappedTableResource()

writeOperations

public Collection<BatchableWriteOperation<T>> writeOperations()

addWriteRequestsToMap

public void addWriteRequestsToMap(Map<String,Collection<WriteRequest>> writeRequestMap)

This method is used by the internal batchWriteItem operation to generate list of batch write requests used in the call to DynamoDb. Each BatchableWriteOperation, such as PutItem, creates a batch write request corresponding to that operation. The method should only be called from the batchWriteItem operation and should not be used for other purposes.

Parameters:

writeRequestMap - An empty map to store the batch write requests in. Due to raw-type erasure, it's necessary to pass a map in to be mutated rather than try and extract the write requests which would be more straight forward, but Collection becomes Collection when you try and exfiltrate the objects from a raw-typed WriteBatch.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object