Class PutItemResult
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.model.PutItemResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class PutItemResult extends Object implements Serializable, Cloneable
Represents the output of a PutItem operation.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description PutItemResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PutItemResult
addAttributesEntry(String key, AttributeValue value)
PutItemResult
clearAttributesEntries()
Removes all the entries added into Attributes.PutItemResult
clone()
boolean
equals(Object obj)
Map<String,AttributeValue>
getAttributes()
The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified asALL_OLD
in the request.ConsumedCapacity
getConsumedCapacity()
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 asALL_OLD
in the request.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.PutItemResult
withAttributes(Map<String,AttributeValue> attributes)
The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified asALL_OLD
in the request.PutItemResult
withConsumedCapacity(ConsumedCapacity consumedCapacity)
PutItemResult
withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
Information about item collections, if any, that were affected by the operation.
-
-
-
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 asALL_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.- Parameters:
attributes
- The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified asALL_OLD
in the request. Each element consists of an attribute name and an attribute value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addAttributesEntry
public PutItemResult addAttributesEntry(String key, AttributeValue value)
-
clearAttributesEntries
public PutItemResult 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 PutItemResult 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 PutItemResult 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 PutItemResult clone()
-
-