Package software.amazon.awssdk.enhanced.dynamodb.model

Class BatchWriteResult

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.BatchWriteResult

@ThreadSafe
public final class BatchWriteResult
extends Object

Defines the result of the batchWriteItem() operation, such as DynamoDbEnhancedClient.batchWriteItem(BatchWriteItemEnhancedRequest). The result describes any unprocessed items after the operation completes.

• Use the unprocessedPutItemsForTable(MappedTableResource) method once for each table present in the request to get any unprocessed items from a put action on that table.
• Use the unprocessedDeleteItemsForTable(MappedTableResource) method once for each table present in the request to get any unprocessed items from a delete action on that table.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BatchWriteResult.Builder	builder()	Creates a newly initialized builder for a request object.
List<ConsumedCapacity>	consumedCapacity()	Returns capacity units consumed by the BatchWrite operation.
boolean	equals(Object o)
int	hashCode()
Map<String,List<ItemCollectionMetrics>>	itemCollectionMetrics()	Returns ItemCollectionMetrics by the BatchWrite operation.
List<Key>	unprocessedDeleteItemsForTable(MappedTableResource<?> mappedTable)	Retrieve any unprocessed delete action keys belonging to the supplied table from the result.
<T> List<T>	unprocessedPutItemsForTable(MappedTableResource<T> mappedTable)	Retrieve any unprocessed put action items belonging to the supplied table from the result .

Methods inherited from class java.lang.Object

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

Method Detail

consumedCapacity

public List<ConsumedCapacity> consumedCapacity()

Returns capacity units consumed by the BatchWrite operation.

See Also:

for more information.

itemCollectionMetrics

public Map<String,List<ItemCollectionMetrics>> itemCollectionMetrics()

Returns ItemCollectionMetrics by the BatchWrite operation.

See Also:

for more information.

builder

public static BatchWriteResult.Builder builder()

Creates a newly initialized builder for a request object.

unprocessedPutItemsForTable

public <T> List<T> unprocessedPutItemsForTable(MappedTableResource<T> mappedTable)

Retrieve any unprocessed put action items belonging to the supplied table from the result . Call this method once for each table present in the batch request.

Type Parameters:

T - the type of the table items

Parameters:

mappedTable - the table to retrieve unprocessed items for

Returns:

a list of items

unprocessedDeleteItemsForTable

public List<Key> unprocessedDeleteItemsForTable(MappedTableResource<?> mappedTable)

Retrieve any unprocessed delete action keys belonging to the supplied table from the result. Call this method once for each table present in the batch request.

Parameters:

mappedTable - the table to retrieve unprocessed items for.

Returns:

a list of keys that were not processed as part of the batch request.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object