com.amazonaws.services.dynamodbv2.model

Class PutItemResult

java.lang.Object

com.amazonaws.services.dynamodbv2.model.PutItemResult

All Implemented Interfaces:

java.io.Serializable

public class PutItemResult
extends java.lang.Object
implements java.io.Serializable

Represents the output of a PutItem operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PutItemResult()

Method Summary

Modifier and Type	Method and Description
PutItemResult	addAttributesEntry(java.lang.String key, AttributeValue value) The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request.
PutItemResult	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,AttributeValue>	getAttributes() The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request.
ConsumedCapacity	getConsumedCapacity() The capacity units consumed by the PutItem operation.
ItemCollectionMetrics	getItemCollectionMetrics() Information about item collections, if any, that were affected by the PutItem operation.
int	hashCode()
void	setAttributes(java.util.Map<java.lang.String,AttributeValue> attributes) The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request.
void	setConsumedCapacity(ConsumedCapacity consumedCapacity) The capacity units consumed by the PutItem operation.
void	setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) Information about item collections, if any, that were affected by the PutItem operation.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
PutItemResult	withAttributes(java.util.Map<java.lang.String,AttributeValue> attributes) The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request.
PutItemResult	withConsumedCapacity(ConsumedCapacity consumedCapacity) The capacity units consumed by the PutItem operation.
PutItemResult	withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) Information about item collections, if any, that were affected by the PutItem operation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutItemResult

public PutItemResult()

Method Detail

getAttributes

public java.util.Map<java.lang.String,AttributeValue> getAttributes()

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

Returns:

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,AttributeValue> attributes)

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

Parameters:

attributes -

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

withAttributes

public PutItemResult withAttributes(java.util.Map<java.lang.String,AttributeValue> attributes)

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

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

Parameters:

attributes -

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

Returns:

A reference to this updated object so that method calls can be chained together.

addAttributesEntry

public PutItemResult addAttributesEntry(java.lang.String key,
                                        AttributeValue value)

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

clearAttributesEntries

public PutItemResult clearAttributesEntries()

Removes all the entries added into Attributes.

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

getConsumedCapacity

public ConsumedCapacity getConsumedCapacity()

The capacity units consumed by the PutItem 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 PutItem 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.

setConsumedCapacity

public void setConsumedCapacity(ConsumedCapacity consumedCapacity)

The capacity units consumed by the PutItem 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 PutItem 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 PutItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity)

The capacity units consumed by the PutItem 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 a reference to this object so that method calls can be chained together.

Parameters:

consumedCapacity -

The capacity units consumed by the PutItem 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:

A reference to this updated object so that method calls can be chained together.

getItemCollectionMetrics

public ItemCollectionMetrics getItemCollectionMetrics()

Information about item collections, if any, that were affected by the PutItem 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 PutItem 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.

setItemCollectionMetrics

public void setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)

Information about item collections, if any, that were affected by the PutItem 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 PutItem 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 PutItemResult withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)

Information about item collections, if any, that were affected by the PutItem 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 a reference to this object so that method calls can be chained together.

Parameters:

itemCollectionMetrics -

Information about item collections, if any, that were affected by the PutItem 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:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object