com.amazonaws.services.dynamodbv2.model

Class UpdateItemResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.dynamodbv2.model.UpdateItemResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateItemResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents the output of an UpdateItem operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateItemResult()

Method Summary

Modifier and Type	Method and Description
UpdateItemResult	addAttributesEntry(String key, AttributeValue value)
UpdateItemResult	clearAttributesEntries() Removes all the entries added into Attributes.
UpdateItemResult	clone()
boolean	equals(Object obj)
Map<String,AttributeValue>	getAttributes() A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.
ConsumedCapacity	getConsumedCapacity() The capacity units consumed by the UpdateItem operation.
ItemCollectionMetrics	getItemCollectionMetrics() Information about item collections, if any, that were affected by the UpdateItem operation.
int	hashCode()
void	setAttributes(Map<String,AttributeValue> attributes) A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.
void	setConsumedCapacity(ConsumedCapacity consumedCapacity) The capacity units consumed by the UpdateItem operation.
void	setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) Information about item collections, if any, that were affected by the UpdateItem operation.
String	toString() Returns a string representation of this object.
UpdateItemResult	withAttributes(Map<String,AttributeValue> attributes) A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.
UpdateItemResult	withConsumedCapacity(ConsumedCapacity consumedCapacity) The capacity units consumed by the UpdateItem operation.
UpdateItemResult	withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) Information about item collections, if any, that were affected by the UpdateItem operation.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateItemResult

public UpdateItemResult()

Method Detail

getAttributes

public Map<String,AttributeValue> getAttributes()

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.

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.

setAttributes

public void setAttributes(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.

Parameters:

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.

withAttributes

public UpdateItemResult withAttributes(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAttributesEntry

public UpdateItemResult addAttributesEntry(String key,
                                           AttributeValue value)

clearAttributesEntries

public UpdateItemResult clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConsumedCapacity

public void setConsumedCapacity(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.

Parameters:

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.

getConsumedCapacity

public ConsumedCapacity getConsumedCapacity()

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.

withConsumedCapacity

public UpdateItemResult withConsumedCapacity(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setItemCollectionMetrics

public void setItemCollectionMetrics(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.

Parameters:

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.

getItemCollectionMetrics

public ItemCollectionMetrics getItemCollectionMetrics()

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.

withItemCollectionMetrics

public UpdateItemResult withItemCollectionMetrics(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateItemResult clone()

Overrides:

clone in class Object