com.amazonaws.services.dynamodbv2.model
Class DeleteItemResult

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

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

Represents the output of a DeleteItem operation.

See Also:
Serialized Form

Constructor Summary
DeleteItemResult()
           
 
Method Summary
 DeleteItemResult addAttributesEntry(java.lang.String key, AttributeValue value)
          A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation.
 DeleteItemResult clearAttributesEntries()
          Removes all the entries added into Attributes.
 boolean equals(java.lang.Object obj)
           
 java.util.Map<java.lang.String,AttributeValue> getAttributes()
          A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation.
 ConsumedCapacity getConsumedCapacity()
          Represents the capacity units consumed by an operation.
 ItemCollectionMetrics getItemCollectionMetrics()
          Information about item collections, if any, that were affected by the operation.
 int hashCode()
           
 void setAttributes(java.util.Map<java.lang.String,AttributeValue> attributes)
          A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation.
 void setConsumedCapacity(ConsumedCapacity consumedCapacity)
          Represents the capacity units consumed by an operation.
 void setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
          Information about item collections, if any, that were affected by the operation.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DeleteItemResult withAttributes(java.util.Map<java.lang.String,AttributeValue> attributes)
          A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation.
 DeleteItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
          Represents the capacity units consumed by an operation.
 DeleteItemResult 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

DeleteItemResult

public DeleteItemResult()
Method Detail

getAttributes

public java.util.Map<java.lang.String,AttributeValue> getAttributes()
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

Returns:
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,AttributeValue> attributes)
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

Parameters:
attributes - A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

withAttributes

public DeleteItemResult withAttributes(java.util.Map<java.lang.String,AttributeValue> attributes)
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

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

Parameters:
attributes - A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.
Returns:
A reference to this updated object so that method calls can be chained together.

addAttributesEntry

public DeleteItemResult addAttributesEntry(java.lang.String key,
                                           AttributeValue value)
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

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.

clearAttributesEntries

public DeleteItemResult 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()
Represents the capacity units consumed by an 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 it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Returns:
Represents the capacity units consumed by an 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 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)
Represents the capacity units consumed by an 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 it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Parameters:
consumedCapacity - Represents the capacity units consumed by an 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 it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

withConsumedCapacity

public DeleteItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
Represents the capacity units consumed by an 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 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 - Represents the capacity units consumed by an 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 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 local 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 local 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 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 operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any local 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 local 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 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 DeleteItemResult 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 local 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 local 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 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


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