software.amazon.awssdk.services.dynamodb.model

Class UpdateItemResponse

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.UpdateItemResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateItemResponse.Builder,UpdateItemResponse>

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

Represents the output of an UpdateItem operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateItemResponse.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,AttributeValue>	attributes() A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.
static UpdateItemResponse.Builder	builder()
ConsumedCapacity	consumedCapacity() The capacity units consumed by the UpdateItem operation.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ItemCollectionMetrics	itemCollectionMetrics() Information about item collections, if any, that were affected by the UpdateItem operation.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateItemResponse.Builder>	serializableBuilderClass()
UpdateItemResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

attributes

public Map<String,AttributeValue> attributes()

A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.

The Attributes map is only present if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

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

Returns:

A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.

The Attributes map is only present if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

consumedCapacity

public ConsumedCapacity consumedCapacity()

The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Returns:

The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

itemCollectionMetrics

public ItemCollectionMetrics itemCollectionMetrics()

Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

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

• SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value 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 that 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.

Returns:

Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

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

• SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value 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 that 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.

toBuilder

public UpdateItemResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateItemResponse.Builder,UpdateItemResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static UpdateItemResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo