Class PutItemResult
- All Implemented Interfaces:
Serializable
,Cloneable
Represents the output of a PutItem operation.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAttributesEntry
(String key, AttributeValue value) Removes all the entries added into Attributes.clone()
boolean
The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified asALL_OLD
in the request.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.toString()
Returns a string representation of this object; useful for testing and debugging.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.withConsumedCapacity
(ConsumedCapacity consumedCapacity) withItemCollectionMetrics
(ItemCollectionMetrics itemCollectionMetrics) Information about item collections, if any, that were affected by the operation.
-
Constructor Details
-
PutItemResult
public PutItemResult()
-
-
Method Details
-
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
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
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
-
clearAttributesEntries
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together. -
setConsumedCapacity
- Parameters:
consumedCapacity
-
-
getConsumedCapacity
- Returns:
-
withConsumedCapacity
- Parameters:
consumedCapacity
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setItemCollectionMetrics
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-