Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.dynamodbv2.model
Class PutItemResult

java.lang.Object
  extended by com.amazonaws.services.dynamodbv2.model.PutItemResult
All Implemented Interfaces:
Serializable

public class PutItemResult
extends Object
implements Serializable

Represents the output of a PutItem operation.

See Also:
Serialized Form

Constructor Summary
PutItemResult()
           
 
Method Summary
 boolean equals(Object obj)
           
 Map<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 table name that consumed provisioned throughput, and the number of capacity units consumed by it.
 ItemCollectionMetrics getItemCollectionMetrics()
          Information about item collections, if any, that were affected by the operation.
 int hashCode()
           
 void setAttributes(Map<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 table name that consumed provisioned throughput, and the number of capacity units consumed by it.
 void setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
          Information about item collections, if any, that were affected by the operation.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 PutItemResult withAttributes(Map<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 table name that consumed provisioned throughput, and the number of capacity units consumed by it.
 PutItemResult withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
          Information about item collections, if any, that were affected by the operation.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PutItemResult

public PutItemResult()
Method Detail

getAttributes

public Map<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(Map<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(Map<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.

getConsumedCapacity

public ConsumedCapacity getConsumedCapacity()
The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Returns:
The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

setConsumedCapacity

public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Parameters:
consumedCapacity - The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

withConsumedCapacity

public PutItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. 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 table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. 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 operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

Returns:
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

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

  • SizeEstimateRange - An estimate of item collection size, measured in gigabytes. 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 secondary indexes on that table. Use this estimate to measure whether a 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 operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

Parameters:
itemCollectionMetrics - Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

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

  • SizeEstimateRange - An estimate of item collection size, measured in gigabytes. 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 secondary indexes on that table. Use this estimate to measure whether a 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 operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

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 operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

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

  • SizeEstimateRange - An estimate of item collection size, measured in gigabytes. 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 secondary indexes on that table. Use this estimate to measure whether a 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 String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.