@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateItemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents the output of an UpdateItem
operation.
Constructor and Description |
---|
UpdateItemResult() |
Modifier and Type | Method and Description |
---|---|
UpdateItemResult |
addAttributesEntry(String key,
AttributeValue value)
Add a single Attributes entry
|
UpdateItemResult |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
UpdateItemResult |
clone() |
boolean |
equals(Object obj) |
Map<String,AttributeValue> |
getAttributes()
A map of attribute values as they appear before or after the
UpdateItem operation, as determined by
the ReturnValues parameter. |
ConsumedCapacity |
getConsumedCapacity()
The capacity units consumed by the
UpdateItem operation. |
ItemCollectionMetrics |
getItemCollectionMetrics()
Information about item collections, if any, that were affected by the
UpdateItem operation. |
int |
hashCode() |
void |
setAttributes(Map<String,AttributeValue> attributes)
A map of attribute values as they appear before or after the
UpdateItem operation, as determined by
the ReturnValues parameter. |
void |
setConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the
UpdateItem operation. |
void |
setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
Information about item collections, if any, that were affected by the
UpdateItem operation. |
String |
toString()
Returns a string representation of this object.
|
UpdateItemResult |
withAttributes(Map<String,AttributeValue> attributes)
A map of attribute values as they appear before or after the
UpdateItem operation, as determined by
the ReturnValues parameter. |
UpdateItemResult |
withConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the
UpdateItem operation. |
UpdateItemResult |
withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
Information about item collections, if any, that were affected by the
UpdateItem operation. |
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public Map<String,AttributeValue> getAttributes()
A map of attribute values as they appear before or after the UpdateItem
operation, as determined by
the ReturnValues
parameter.
The Attributes
map is only present if the update was successful and ReturnValues
was
specified as something other than NONE
in the request. Each element represents one attribute.
UpdateItem
operation, as
determined by the ReturnValues
parameter.
The Attributes
map is only present if the update was successful and
ReturnValues
was specified as something other than NONE
in the request. Each
element represents one attribute.
public void setAttributes(Map<String,AttributeValue> attributes)
A map of attribute values as they appear before or after the UpdateItem
operation, as determined by
the ReturnValues
parameter.
The Attributes
map is only present if the update was successful and ReturnValues
was
specified as something other than NONE
in the request. Each element represents one attribute.
attributes
- A map of attribute values as they appear before or after the UpdateItem
operation, as
determined by the ReturnValues
parameter.
The Attributes
map is only present if the update was successful and ReturnValues
was specified as something other than NONE
in the request. Each element represents one
attribute.
public UpdateItemResult withAttributes(Map<String,AttributeValue> attributes)
A map of attribute values as they appear before or after the UpdateItem
operation, as determined by
the ReturnValues
parameter.
The Attributes
map is only present if the update was successful and ReturnValues
was
specified as something other than NONE
in the request. Each element represents one attribute.
attributes
- A map of attribute values as they appear before or after the UpdateItem
operation, as
determined by the ReturnValues
parameter.
The Attributes
map is only present if the update was successful and ReturnValues
was specified as something other than NONE
in the request. Each element represents one
attribute.
public UpdateItemResult addAttributesEntry(String key, AttributeValue value)
public UpdateItemResult clearAttributesEntries()
public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the UpdateItem
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 the ReturnConsumedCapacity
parameter was
specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.
consumedCapacity
- The capacity units consumed by the UpdateItem
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 the ReturnConsumedCapacity
parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.public ConsumedCapacity getConsumedCapacity()
The capacity units consumed by the UpdateItem
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 the ReturnConsumedCapacity
parameter was
specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.
UpdateItem
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 the ReturnConsumedCapacity
parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.public UpdateItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the UpdateItem
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 the ReturnConsumedCapacity
parameter was
specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.
consumedCapacity
- The capacity units consumed by the UpdateItem
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 the ReturnConsumedCapacity
parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.public void setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
Information about item collections, if any, that were affected by the UpdateItem
operation.
ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was
specified. 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.
SizeEstimateRangeGB
- 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.
itemCollectionMetrics
- Information about item collections, if any, that were affected by the UpdateItem
operation.
ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was specified. 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.
SizeEstimateRangeGB
- 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.
public ItemCollectionMetrics getItemCollectionMetrics()
Information about item collections, if any, that were affected by the UpdateItem
operation.
ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was
specified. 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.
SizeEstimateRangeGB
- 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.
UpdateItem
operation.
ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was specified. 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.
SizeEstimateRangeGB
- 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.
public UpdateItemResult withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
Information about item collections, if any, that were affected by the UpdateItem
operation.
ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was
specified. 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.
SizeEstimateRangeGB
- 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.
itemCollectionMetrics
- Information about item collections, if any, that were affected by the UpdateItem
operation.
ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was specified. 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.
SizeEstimateRangeGB
- 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.
public String toString()
toString
in class Object
Object.toString()
public UpdateItemResult clone()