software.amazon.awssdk.services.dynamodb.model

Class BatchWriteItemResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse

software.amazon.awssdk.services.dynamodb.model.BatchWriteItemResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchWriteItemResponse.Builder,BatchWriteItemResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchWriteItemResponse
extends DynamoDbResponse
implements ToCopyableBuilder<BatchWriteItemResponse.Builder,BatchWriteItemResponse>

Represents the output of a BatchWriteItem operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchWriteItemResponse.Builder

Method Summary

Modifier and Type	Method and Description
static BatchWriteItemResponse.Builder	builder()
List<ConsumedCapacity>	consumedCapacity() The capacity units consumed by the entire BatchWriteItem operation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConsumedCapacity() Returns true if the ConsumedCapacity property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasItemCollectionMetrics() Returns true if the ItemCollectionMetrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUnprocessedItems() Returns true if the UnprocessedItems property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,List<ItemCollectionMetrics>>	itemCollectionMetrics() A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchWriteItemResponse.Builder>	serializableBuilderClass()
BatchWriteItemResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,List<WriteRequest>>	unprocessedItems() A map of tables and requests against those tables that were not processed.

Methods inherited from class software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasUnprocessedItems

public final boolean hasUnprocessedItems()

Returns true if the UnprocessedItems property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

unprocessedItems

public final Map<String,List<WriteRequest>> unprocessedItems()

A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasUnprocessedItems() to see if a value was sent in this field.

Returns:

A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

hasItemCollectionMetrics

public final boolean hasItemCollectionMetrics()

Returns true if the ItemCollectionMetrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

itemCollectionMetrics

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

A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

Each entry consists of the following subelements:

• ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

• SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasItemCollectionMetrics() to see if a value was sent in this field.

Returns:

A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

Each entry consists of the following subelements:

• ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

• SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

hasConsumedCapacity

public final boolean hasConsumedCapacity()

Returns true if the ConsumedCapacity property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

consumedCapacity

public final List<ConsumedCapacity> consumedCapacity()

The capacity units consumed by the entire BatchWriteItem operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasConsumedCapacity() to see if a value was sent in this field.

Returns:

The capacity units consumed by the entire BatchWriteItem operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

toBuilder

public BatchWriteItemResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchWriteItemResponse.Builder,BatchWriteItemResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static BatchWriteItemResponse.Builder builder()

serializableBuilderClass

public static Class<? extends BatchWriteItemResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo