Class BatchWriteItemResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<BatchWriteItemResponse.Builder,
BatchWriteItemResponse>
Represents the output of a BatchWriteItem
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final List
<ConsumedCapacity> The capacity units consumed by the entireBatchWriteItem
operation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ConsumedCapacity property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ItemCollectionMetrics property.final boolean
For responses, this returns true if the service returned a value for the UnprocessedItems property.final Map
<String, List<ItemCollectionMetrics>> A list of tables that were processed byBatchWriteItem
and, for each table, information about any item collections that were affected by individualDeleteItem
orPutItem
operations.static Class
<? extends BatchWriteItemResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Map
<String, List<WriteRequest>> 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasUnprocessedItems
public final boolean hasUnprocessedItems()For responses, this returns true if the service returned a value for the UnprocessedItems property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
unprocessedItems
A map of tables and requests against those tables that were not processed. The
UnprocessedItems
value is in the same form asRequestItems
, so you can provide this value directly to a subsequentBatchWriteItem
operation. For more information, seeRequestItems
in the Request Parameters section.Each
UnprocessedItems
entry consists of a table name or table ARN and, for that table, a list of operations to perform (DeleteRequest
orPutRequest
).-
DeleteRequest
- Perform aDeleteItem
operation on the specified item. The item to be deleted is identified by aKey
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 aPutItem
operation on the specified item. The item to be put is identified by anItem
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 aValidationException
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUnprocessedItems()
method.- Returns:
- A map of tables and requests against those tables that were not processed. The
UnprocessedItems
value is in the same form asRequestItems
, so you can provide this value directly to a subsequentBatchWriteItem
operation. For more information, seeRequestItems
in the Request Parameters section.Each
UnprocessedItems
entry consists of a table name or table ARN and, for that table, a list of operations to perform (DeleteRequest
orPutRequest
).-
DeleteRequest
- Perform aDeleteItem
operation on the specified item. The item to be deleted is identified by aKey
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 aPutItem
operation on the specified item. The item to be put is identified by anItem
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 aValidationException
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()For responses, this returns true if the service returned a value for the ItemCollectionMetrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
itemCollectionMetrics
A list of tables that were processed by
BatchWriteItem
and, for each table, information about any item collections that were affected by individualDeleteItem
orPutItem
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasItemCollectionMetrics()
method.- Returns:
- A list of tables that were processed by
BatchWriteItem
and, for each table, information about any item collections that were affected by individualDeleteItem
orPutItem
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()For responses, this returns true if the service returned a value for the ConsumedCapacity property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasConsumedCapacity()
method.- 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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BatchWriteItemResponse.Builder,
BatchWriteItemResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-