/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
* <p>
* Represents the output of an <code>UpdateItem</code> operation.
* </p>
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateItem" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateItemResult extends com.amazonaws.AmazonWebServiceResult<com.amazonaws.ResponseMetadata> implements Serializable, Cloneable {
/**
* <p>
* A map of attribute values as they appeared before the <code>UpdateItem</code> operation. This map only appears if
* <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the request. Each element
* represents one attribute.
* </p>
*/
private java.util.Map<String, AttributeValue> attributes;
/**
* <p>
* The capacity units consumed by the <code>UpdateItem</code> operation. The data returned includes the total
* provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.
* <code>ConsumedCapacity</code> is only returned if the <code>ReturnConsumedCapacity</code> parameter was
* specified. For more information, see <a
* href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html"
* >Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*/
private ConsumedCapacity consumedCapacity;
/**
* <p>
* Information about item collections, if any, that were affected by the <code>UpdateItem</code> operation.
* <code>ItemCollectionMetrics</code> is only returned if the <code>ReturnItemCollectionMetrics</code> parameter was
* specified. If the table does not have any local secondary indexes, this information is not returned in the
* response.
* </p>
* <p>
* Each <code>ItemCollectionMetrics</code> element consists of:
* </p>
* <ul>
* <li>
* <p>
* <code>ItemCollectionKey</code> - The partition key value of the item collection. This is the same as the
* partition key value of the item itself.
* </p>
* </li>
* <li>
* <p>
* <code>SizeEstimateRange</code> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*/
private ItemCollectionMetrics itemCollectionMetrics;
/**
* <p>
* A map of attribute values as they appeared before the <code>UpdateItem</code> operation. This map only appears if
* <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the request. Each element
* represents one attribute.
* </p>
*
* @return A map of attribute values as they appeared before the <code>UpdateItem</code> operation. This map only
* appears if <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the
* request. Each element represents one attribute.
*/
public java.util.Map<String, AttributeValue> getAttributes() {
return attributes;
}
/**
* <p>
* A map of attribute values as they appeared before the <code>UpdateItem</code> operation. This map only appears if
* <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the request. Each element
* represents one attribute.
* </p>
*
* @param attributes
* A map of attribute values as they appeared before the <code>UpdateItem</code> operation. This map only
* appears if <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the
* request. Each element represents one attribute.
*/
public void setAttributes(java.util.Map<String, AttributeValue> attributes) {
this.attributes = attributes;
}
/**
* <p>
* A map of attribute values as they appeared before the <code>UpdateItem</code> operation. This map only appears if
* <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the request. Each element
* represents one attribute.
* </p>
*
* @param attributes
* A map of attribute values as they appeared before the <code>UpdateItem</code> operation. This map only
* appears if <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the
* request. Each element represents one attribute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateItemResult withAttributes(java.util.Map<String, AttributeValue> attributes) {
setAttributes(attributes);
return this;
}
public UpdateItemResult addAttributesEntry(String key, AttributeValue value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap<String, AttributeValue>();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateItemResult clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
* <p>
* The capacity units consumed by the <code>UpdateItem</code> operation. The data returned includes the total
* provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.
* <code>ConsumedCapacity</code> is only returned if the <code>ReturnConsumedCapacity</code> parameter was
* specified. For more information, see <a
* href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html"
* >Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*
* @param consumedCapacity
* The capacity units consumed by the <code>UpdateItem</code> operation. The data returned includes the total
* provisioned throughput consumed, along with statistics for the table and any indexes involved in the
* operation. <code>ConsumedCapacity</code> is only returned if the <code>ReturnConsumedCapacity</code>
* parameter was specified. For more information, see <a
* href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html"
* >Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer Guide</i>.
*/
public void setConsumedCapacity(ConsumedCapacity consumedCapacity) {
this.consumedCapacity = consumedCapacity;
}
/**
* <p>
* The capacity units consumed by the <code>UpdateItem</code> operation. The data returned includes the total
* provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.
* <code>ConsumedCapacity</code> is only returned if the <code>ReturnConsumedCapacity</code> parameter was
* specified. For more information, see <a
* href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html"
* >Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*
* @return The capacity units consumed by the <code>UpdateItem</code> operation. The data returned includes the
* total provisioned throughput consumed, along with statistics for the table and any indexes involved in
* the operation. <code>ConsumedCapacity</code> is only returned if the <code>ReturnConsumedCapacity</code>
* parameter was specified. For more information, see <a
* href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html"
* >Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer Guide</i>.
*/
public ConsumedCapacity getConsumedCapacity() {
return this.consumedCapacity;
}
/**
* <p>
* The capacity units consumed by the <code>UpdateItem</code> operation. The data returned includes the total
* provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.
* <code>ConsumedCapacity</code> is only returned if the <code>ReturnConsumedCapacity</code> parameter was
* specified. For more information, see <a
* href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html"
* >Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*
* @param consumedCapacity
* The capacity units consumed by the <code>UpdateItem</code> operation. The data returned includes the total
* provisioned throughput consumed, along with statistics for the table and any indexes involved in the
* operation. <code>ConsumedCapacity</code> is only returned if the <code>ReturnConsumedCapacity</code>
* parameter was specified. For more information, see <a
* href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html"
* >Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity) {
setConsumedCapacity(consumedCapacity);
return this;
}
/**
* <p>
* Information about item collections, if any, that were affected by the <code>UpdateItem</code> operation.
* <code>ItemCollectionMetrics</code> is only returned if the <code>ReturnItemCollectionMetrics</code> parameter was
* specified. If the table does not have any local secondary indexes, this information is not returned in the
* response.
* </p>
* <p>
* Each <code>ItemCollectionMetrics</code> element consists of:
* </p>
* <ul>
* <li>
* <p>
* <code>ItemCollectionKey</code> - The partition key value of the item collection. This is the same as the
* partition key value of the item itself.
* </p>
* </li>
* <li>
* <p>
* <code>SizeEstimateRange</code> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*
* @param itemCollectionMetrics
* Information about item collections, if any, that were affected by the <code>UpdateItem</code> operation.
* <code>ItemCollectionMetrics</code> is only returned if the <code>ReturnItemCollectionMetrics</code>
* parameter was specified. If the table does not have any local secondary indexes, this information is not
* returned in the response.</p>
* <p>
* Each <code>ItemCollectionMetrics</code> element consists of:
* </p>
* <ul>
* <li>
* <p>
* <code>ItemCollectionKey</code> - The partition key value of the item collection. This is the same as the
* partition key value of the item itself.
* </p>
* </li>
* <li>
* <p>
* <code>SizeEstimateRange</code> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the
* estimate.
* </p>
* </li>
*/
public void setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) {
this.itemCollectionMetrics = itemCollectionMetrics;
}
/**
* <p>
* Information about item collections, if any, that were affected by the <code>UpdateItem</code> operation.
* <code>ItemCollectionMetrics</code> is only returned if the <code>ReturnItemCollectionMetrics</code> parameter was
* specified. If the table does not have any local secondary indexes, this information is not returned in the
* response.
* </p>
* <p>
* Each <code>ItemCollectionMetrics</code> element consists of:
* </p>
* <ul>
* <li>
* <p>
* <code>ItemCollectionKey</code> - The partition key value of the item collection. This is the same as the
* partition key value of the item itself.
* </p>
* </li>
* <li>
* <p>
* <code>SizeEstimateRange</code> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*
* @return Information about item collections, if any, that were affected by the <code>UpdateItem</code> operation.
* <code>ItemCollectionMetrics</code> is only returned if the <code>ReturnItemCollectionMetrics</code>
* parameter was specified. If the table does not have any local secondary indexes, this information is not
* returned in the response.</p>
* <p>
* Each <code>ItemCollectionMetrics</code> element consists of:
* </p>
* <ul>
* <li>
* <p>
* <code>ItemCollectionKey</code> - The partition key value of the item collection. This is the same as the
* partition key value of the item itself.
* </p>
* </li>
* <li>
* <p>
* <code>SizeEstimateRange</code> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the
* estimate.
* </p>
* </li>
*/
public ItemCollectionMetrics getItemCollectionMetrics() {
return this.itemCollectionMetrics;
}
/**
* <p>
* Information about item collections, if any, that were affected by the <code>UpdateItem</code> operation.
* <code>ItemCollectionMetrics</code> is only returned if the <code>ReturnItemCollectionMetrics</code> parameter was
* specified. If the table does not have any local secondary indexes, this information is not returned in the
* response.
* </p>
* <p>
* Each <code>ItemCollectionMetrics</code> element consists of:
* </p>
* <ul>
* <li>
* <p>
* <code>ItemCollectionKey</code> - The partition key value of the item collection. This is the same as the
* partition key value of the item itself.
* </p>
* </li>
* <li>
* <p>
* <code>SizeEstimateRange</code> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
* </p>
* </li>
* </ul>
*
* @param itemCollectionMetrics
* Information about item collections, if any, that were affected by the <code>UpdateItem</code> operation.
* <code>ItemCollectionMetrics</code> is only returned if the <code>ReturnItemCollectionMetrics</code>
* parameter was specified. If the table does not have any local secondary indexes, this information is not
* returned in the response.</p>
* <p>
* Each <code>ItemCollectionMetrics</code> element consists of:
* </p>
* <ul>
* <li>
* <p>
* <code>ItemCollectionKey</code> - The partition key value of the item collection. This is the same as the
* partition key value of the item itself.
* </p>
* </li>
* <li>
* <p>
* <code>SizeEstimateRange</code> - 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.
* </p>
* <p>
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the
* estimate.
* </p>
* </li>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateItemResult withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) {
setItemCollectionMetrics(itemCollectionMetrics);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes()).append(",");
if (getConsumedCapacity() != null)
sb.append("ConsumedCapacity: ").append(getConsumedCapacity()).append(",");
if (getItemCollectionMetrics() != null)
sb.append("ItemCollectionMetrics: ").append(getItemCollectionMetrics());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateItemResult == false)
return false;
UpdateItemResult other = (UpdateItemResult) obj;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
if (other.getConsumedCapacity() == null ^ this.getConsumedCapacity() == null)
return false;
if (other.getConsumedCapacity() != null && other.getConsumedCapacity().equals(this.getConsumedCapacity()) == false)
return false;
if (other.getItemCollectionMetrics() == null ^ this.getItemCollectionMetrics() == null)
return false;
if (other.getItemCollectionMetrics() != null && other.getItemCollectionMetrics().equals(this.getItemCollectionMetrics()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
hashCode = prime * hashCode + ((getConsumedCapacity() == null) ? 0 : getConsumedCapacity().hashCode());
hashCode = prime * hashCode + ((getItemCollectionMetrics() == null) ? 0 : getItemCollectionMetrics().hashCode());
return hashCode;
}
@Override
public UpdateItemResult clone() {
try {
return (UpdateItemResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}