com.amazonaws.services.dynamodbv2.model.PutItemResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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;
/**
*
* Represents the output of a PutItem operation.
*
*/
public class PutItemResult implements Serializable {
/**
* 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.
*/
private java.util.Map attributes;
/**
* Represents the capacity units consumed by an 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*/
private ConsumedCapacity consumedCapacity;
/**
* Information about item collections, if any, that were affected by the
* operation. ItemCollectionMetrics is only returned if it was
* asked for in the request. 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 hash key value of the item
* collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,
* measured in gigabytes. This 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;
/**
* 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.
*
* @return 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.
*/
public java.util.Map getAttributes() {
return 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.
*
* @param 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.
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutItemResult withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* 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.
*
* The method adds a new key-value pair into Attributes parameter, and
* returns a reference to this object so that method calls can be chained
* together.
*
* @param key The key of the entry to be added into Attributes.
* @param value The corresponding value of the entry to be added into Attributes.
*/
public PutItemResult 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.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public PutItemResult clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
* Represents the capacity units consumed by an 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* @return Represents the capacity units consumed by an 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*/
public ConsumedCapacity getConsumedCapacity() {
return consumedCapacity;
}
/**
* Represents the capacity units consumed by an 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* @param consumedCapacity Represents the capacity units consumed by an 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*/
public void setConsumedCapacity(ConsumedCapacity consumedCapacity) {
this.consumedCapacity = consumedCapacity;
}
/**
* Represents the capacity units consumed by an 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param consumedCapacity Represents the capacity units consumed by an 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity) {
this.consumedCapacity = consumedCapacity;
return this;
}
/**
* Information about item collections, if any, that were affected by the
* operation. ItemCollectionMetrics is only returned if it was
* asked for in the request. 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 hash key value of the item
* collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,
* measured in gigabytes. This 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
* operation. ItemCollectionMetrics is only returned if it was
* asked for in the request. 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 hash key value of the item
* collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,
* measured in gigabytes. This 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 itemCollectionMetrics;
}
/**
* Information about item collections, if any, that were affected by the
* operation. ItemCollectionMetrics is only returned if it was
* asked for in the request. 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 hash key value of the item
* collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,
* measured in gigabytes. This 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
* operation. ItemCollectionMetrics is only returned if it was
* asked for in the request. 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 hash key value of the item
* collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,
* measured in gigabytes. This 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
* operation. ItemCollectionMetrics is only returned if it was
* asked for in the request. 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 hash key value of the item
* collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,
* measured in gigabytes. This 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 a reference to this object so that method calls can be chained together.
*
* @param itemCollectionMetrics Information about item collections, if any, that were affected by the
* operation. ItemCollectionMetrics is only returned if it was
* asked for in the request. 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 hash key value of the item
* collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,
* measured in gigabytes. This 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 A reference to this updated object so that method calls can be chained
* together.
*/
public PutItemResult withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) {
this.itemCollectionMetrics = 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: " + getAttributes() + ",");
if (getConsumedCapacity() != null) sb.append("ConsumedCapacity: " + getConsumedCapacity() + ",");
if (getItemCollectionMetrics() != null) sb.append("ItemCollectionMetrics: " + getItemCollectionMetrics() );
sb.append("}");
return sb.toString();
}
@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 boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof PutItemResult == false) return false;
PutItemResult other = (PutItemResult)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;
}
}