com.amazonaws.services.dynamodbv2.model.PutRequest Maven / Gradle / Ivy
Show all versions of aws-sdk-android Show documentation
/*
* Copyright 2010-2015 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 a request to perform a PutItem operation on an item.
*
*/
public class PutRequest implements Serializable {
/**
* A map of attribute name to attribute values, representing the primary
* key of an item to be processed by PutItem. All of the table's
* primary key attributes must be specified, and their data types must
* match those of the table's key schema. If any attributes are present
* in the item which are part of an index key schema for the table, their
* types must match the index key schema.
*/
private java.util.Map item;
/**
* Default constructor for a new PutRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public PutRequest() {}
/**
* Constructs a new PutRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param item A map of attribute name to attribute values, representing
* the primary key of an item to be processed by PutItem. All of
* the table's primary key attributes must be specified, and their data
* types must match those of the table's key schema. If any attributes
* are present in the item which are part of an index key schema for the
* table, their types must match the index key schema.
*/
public PutRequest(java.util.Map item) {
setItem(item);
}
/**
* A map of attribute name to attribute values, representing the primary
* key of an item to be processed by PutItem. All of the table's
* primary key attributes must be specified, and their data types must
* match those of the table's key schema. If any attributes are present
* in the item which are part of an index key schema for the table, their
* types must match the index key schema.
*
* @return A map of attribute name to attribute values, representing the primary
* key of an item to be processed by PutItem. All of the table's
* primary key attributes must be specified, and their data types must
* match those of the table's key schema. If any attributes are present
* in the item which are part of an index key schema for the table, their
* types must match the index key schema.
*/
public java.util.Map getItem() {
return item;
}
/**
* A map of attribute name to attribute values, representing the primary
* key of an item to be processed by PutItem. All of the table's
* primary key attributes must be specified, and their data types must
* match those of the table's key schema. If any attributes are present
* in the item which are part of an index key schema for the table, their
* types must match the index key schema.
*
* @param item A map of attribute name to attribute values, representing the primary
* key of an item to be processed by PutItem. All of the table's
* primary key attributes must be specified, and their data types must
* match those of the table's key schema. If any attributes are present
* in the item which are part of an index key schema for the table, their
* types must match the index key schema.
*/
public void setItem(java.util.Map item) {
this.item = item;
}
/**
* A map of attribute name to attribute values, representing the primary
* key of an item to be processed by PutItem. All of the table's
* primary key attributes must be specified, and their data types must
* match those of the table's key schema. If any attributes are present
* in the item which are part of an index key schema for the table, their
* types must match the index key schema.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param item A map of attribute name to attribute values, representing the primary
* key of an item to be processed by PutItem. All of the table's
* primary key attributes must be specified, and their data types must
* match those of the table's key schema. If any attributes are present
* in the item which are part of an index key schema for the table, their
* types must match the index key schema.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutRequest withItem(java.util.Map item) {
setItem(item);
return this;
}
/**
* A map of attribute name to attribute values, representing the primary
* key of an item to be processed by PutItem. All of the table's
* primary key attributes must be specified, and their data types must
* match those of the table's key schema. If any attributes are present
* in the item which are part of an index key schema for the table, their
* types must match the index key schema.
*
* The method adds a new key-value pair into Item 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 Item.
* @param value The corresponding value of the entry to be added into Item.
*/
public PutRequest addItemEntry(String key, AttributeValue value) {
if (null == this.item) {
this.item = new java.util.HashMap();
}
if (this.item.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.item.put(key, value);
return this;
}
/**
* Removes all the entries added into Item.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public PutRequest clearItemEntries() {
this.item = null;
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 (getItem() != null) sb.append("Item: " + getItem() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getItem() == null) ? 0 : getItem().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof PutRequest == false) return false;
PutRequest other = (PutRequest)obj;
if (other.getItem() == null ^ this.getItem() == null) return false;
if (other.getItem() != null && other.getItem().equals(this.getItem()) == false) return false;
return true;
}
}