com.amazonaws.services.dynamodbv2.model.UpdateItemResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2019-2024 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;
/**
*
* Represents the output of an UpdateItem operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateItemResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private java.util.Map attributes;
/**
*
* 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.
*
*/
private ConsumedCapacity consumedCapacity;
/**
*
* 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.
*
*
*
*/
private ItemCollectionMetrics itemCollectionMetrics;
/**
*
* 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.
*
*
* @return 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 java.util.Map getAttributes() {
return 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.
*
*
* @param 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 void setAttributes(java.util.Map attributes) {
this.attributes = 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateItemResult withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see UpdateItemResult#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public UpdateItemResult addAttributesEntry(String key, AttributeValue value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap();
}
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;
}
/**
*
* 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.
*
*
* @param 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 setConsumedCapacity(ConsumedCapacity consumedCapacity) {
this.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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity) {
setConsumedCapacity(consumedCapacity);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 void setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) {
this.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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @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. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @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);
}
}
}