Class BatchWriteItemEnhancedRequest

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.BatchWriteItemEnhancedRequest

@ThreadSafe
public final class BatchWriteItemEnhancedRequest
extends Object

Defines parameters used for the batchWriteItem() operation (such as DynamoDbEnhancedClient.batchWriteItem(BatchWriteItemEnhancedRequest)).

A request contains references to keys for delete actions and items for put actions, organized into one WriteBatch object per accessed table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BatchWriteItemEnhancedRequest.Builder	A builder that is used to create a request with the desired parameters.

Method Summary

Modifier and Type	Method	Description
static BatchWriteItemEnhancedRequest.Builder	builder()	Creates a newly initialized builder for a request object.
boolean	equals(Object o)
int	hashCode()
ReturnConsumedCapacity	returnConsumedCapacity()	Whether to return the capacity consumed by this operation.
String	returnConsumedCapacityAsString()	Whether to return the capacity consumed by this operation.
ReturnItemCollectionMetrics	returnItemCollectionMetrics()	Whether to return the item collection metrics.
String	returnItemCollectionMetricsAsString()	Whether to return the item collection metrics.
BatchWriteItemEnhancedRequest.Builder	toBuilder()
Collection<WriteBatch>	writeBatches()	Returns the collection of WriteBatch in this request object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static BatchWriteItemEnhancedRequest.Builder builder()

Creates a newly initialized builder for a request object.

toBuilder

public BatchWriteItemEnhancedRequest.Builder toBuilder()

Returns:

a builder with all existing values set

returnConsumedCapacity

public ReturnConsumedCapacity returnConsumedCapacity()

Whether to return the capacity consumed by this operation.

See Also:

• returnConsumedCapacity()

returnConsumedCapacityAsString

public String returnConsumedCapacityAsString()

Whether to return the capacity consumed by this operation.

Similar to returnConsumedCapacity() but return the value as a string. This is useful in situations where the value is not defined in ReturnConsumedCapacity.

returnItemCollectionMetrics

public ReturnItemCollectionMetrics returnItemCollectionMetrics()

Whether to return the item collection metrics.

See Also:

• BatchWriteItemRequest.returnItemCollectionMetrics()

returnItemCollectionMetricsAsString

public String returnItemCollectionMetricsAsString()

Whether to return the item collection metrics.

Similar to returnItemCollectionMetrics() but return the value as a string. This is useful in situations where the value is not defined in ReturnItemCollectionMetrics.

writeBatches

public Collection<WriteBatch> writeBatches()

Returns the collection of WriteBatch in this request object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object