Class DeleteItemResult
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.model.DeleteItemResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class DeleteItemResult extends Object implements Serializable, Cloneable
Represents the output of a DeleteItem operation.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DeleteItemResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DeleteItemResult
addAttributesEntry(String key, AttributeValue value)
DeleteItemResult
clearAttributesEntries()
Removes all the entries added into Attributes.DeleteItemResult
clone()
boolean
equals(Object obj)
Map<String,AttributeValue>
getAttributes()
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation.ConsumedCapacity
getConsumedCapacity()
ItemCollectionMetrics
getItemCollectionMetrics()
Information about item collections, if any, that were affected by the operation.int
hashCode()
void
setAttributes(Map<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)
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.DeleteItemResult
withAttributes(Map<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)
DeleteItemResult
withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
Information about item collections, if any, that were affected by the operation.
-
-
-
Method Detail
-
getAttributes
public Map<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(Map<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 asALL_OLD
in the request.
-
withAttributes
public DeleteItemResult withAttributes(Map<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 asALL_OLD
in the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addAttributesEntry
public DeleteItemResult addAttributesEntry(String key, AttributeValue value)
-
clearAttributesEntries
public DeleteItemResult clearAttributesEntries()
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together.
-
setConsumedCapacity
public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
- Parameters:
consumedCapacity
-
-
getConsumedCapacity
public ConsumedCapacity getConsumedCapacity()
- Returns:
-
withConsumedCapacity
public DeleteItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
- Parameters:
consumedCapacity
-- 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 operation. ItemCollectionMetrics is only returned if the request asked for it. 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.
-
SizeEstimateRange - 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 operation. ItemCollectionMetrics is only returned if the request asked for it. 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.
-
SizeEstimateRange - 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 operation. ItemCollectionMetrics is only returned if the request asked for it. 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.
-
SizeEstimateRange - 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 operation. ItemCollectionMetrics is only returned if
the request asked for it. 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.
-
SizeEstimateRange - 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 DeleteItemResult withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. 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.
-
SizeEstimateRange - 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 operation. ItemCollectionMetrics is only returned if the request asked for it. 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.
-
SizeEstimateRange - 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; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DeleteItemResult clone()
-
-