com.amazonaws.services.dynamodb.model.UpdateItemRequest 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.dynamodb.model;
import com.amazonaws.AmazonWebServiceRequest;
import java.io.Serializable;
/**
* Container for the parameters to the {@link com.amazonaws.services.dynamodb.AmazonDynamoDB#updateItem(UpdateItemRequest) UpdateItem operation}.
*
* Edits an existing item's attributes.
*
*
* You can perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has
* certain expected attribute values).
*
*
* @see com.amazonaws.services.dynamodb.AmazonDynamoDB#updateItem(UpdateItemRequest)
*
* @deprecated Use {@link com.amazonaws.services.dynamodbv2.model.UpdateItemRequest} instead.
*/
@Deprecated
public class UpdateItemRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the table in which you want to update an item. Allowed
* characters are a-z, A-Z, 0-9,
* _ (underscore), - (hyphen) and
* . (period).
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*/
private String tableName;
/**
* The primary key that uniquely identifies each item in a table. A
* primary key can be a one attribute (hash) primary key or a two
* attribute (hash-and-range) primary key.
*/
private Key key;
/**
* Map of attribute name to the new value and action for the update. The
* attribute names specify the attributes to modify, and cannot contain
* any primary key attributes.
*/
private java.util.Map attributeUpdates;
/**
* Designates an attribute for a conditional modification. The
* Expected parameter allows you to provide an attribute
* name, and whether or not Amazon DynamoDB should check to see if the
* attribute has a particular value before modifying it.
*/
private java.util.Map expected;
/**
* Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW. NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
*/
private String returnValues;
/**
* Default constructor for a new UpdateItemRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public UpdateItemRequest() {}
/**
* Constructs a new UpdateItemRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param tableName The name of the table in which you want to update an
* item. Allowed characters are a-z, A-Z,
* 0-9, _ (underscore), - (hyphen)
* and . (period).
* @param key The primary key that uniquely identifies each item in a
* table. A primary key can be a one attribute (hash) primary key or a
* two attribute (hash-and-range) primary key.
* @param attributeUpdates Map of attribute name to the new value and
* action for the update. The attribute names specify the attributes to
* modify, and cannot contain any primary key attributes.
*/
public UpdateItemRequest(String tableName, Key key, java.util.Map attributeUpdates) {
this.tableName = tableName;
this.key = key;
this.attributeUpdates = attributeUpdates;
}
/**
* The name of the table in which you want to update an item. Allowed
* characters are a-z, A-Z, 0-9,
* _ (underscore), - (hyphen) and
* . (period).
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @return The name of the table in which you want to update an item. Allowed
* characters are a-z, A-Z, 0-9,
* _ (underscore), - (hyphen) and
* . (period).
*/
public String getTableName() {
return tableName;
}
/**
* The name of the table in which you want to update an item. Allowed
* characters are a-z, A-Z, 0-9,
* _ (underscore), - (hyphen) and
* . (period).
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @param tableName The name of the table in which you want to update an item. Allowed
* characters are a-z, A-Z, 0-9,
* _ (underscore), - (hyphen) and
* . (period).
*/
public void setTableName(String tableName) {
this.tableName = tableName;
}
/**
* The name of the table in which you want to update an item. Allowed
* characters are a-z, A-Z, 0-9,
* _ (underscore), - (hyphen) and
* . (period).
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @param tableName The name of the table in which you want to update an item. Allowed
* characters are a-z, A-Z, 0-9,
* _ (underscore), - (hyphen) and
* . (period).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateItemRequest withTableName(String tableName) {
this.tableName = tableName;
return this;
}
/**
* The primary key that uniquely identifies each item in a table. A
* primary key can be a one attribute (hash) primary key or a two
* attribute (hash-and-range) primary key.
*
* @return The primary key that uniquely identifies each item in a table. A
* primary key can be a one attribute (hash) primary key or a two
* attribute (hash-and-range) primary key.
*/
public Key getKey() {
return key;
}
/**
* The primary key that uniquely identifies each item in a table. A
* primary key can be a one attribute (hash) primary key or a two
* attribute (hash-and-range) primary key.
*
* @param key The primary key that uniquely identifies each item in a table. A
* primary key can be a one attribute (hash) primary key or a two
* attribute (hash-and-range) primary key.
*/
public void setKey(Key key) {
this.key = key;
}
/**
* The primary key that uniquely identifies each item in a table. A
* primary key can be a one attribute (hash) primary key or a two
* attribute (hash-and-range) primary key.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param key The primary key that uniquely identifies each item in a table. A
* primary key can be a one attribute (hash) primary key or a two
* attribute (hash-and-range) primary key.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateItemRequest withKey(Key key) {
this.key = key;
return this;
}
/**
* Map of attribute name to the new value and action for the update. The
* attribute names specify the attributes to modify, and cannot contain
* any primary key attributes.
*
* @return Map of attribute name to the new value and action for the update. The
* attribute names specify the attributes to modify, and cannot contain
* any primary key attributes.
*/
public java.util.Map getAttributeUpdates() {
return attributeUpdates;
}
/**
* Map of attribute name to the new value and action for the update. The
* attribute names specify the attributes to modify, and cannot contain
* any primary key attributes.
*
* @param attributeUpdates Map of attribute name to the new value and action for the update. The
* attribute names specify the attributes to modify, and cannot contain
* any primary key attributes.
*/
public void setAttributeUpdates(java.util.Map attributeUpdates) {
this.attributeUpdates = attributeUpdates;
}
/**
* Map of attribute name to the new value and action for the update. The
* attribute names specify the attributes to modify, and cannot contain
* any primary key attributes.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param attributeUpdates Map of attribute name to the new value and action for the update. The
* attribute names specify the attributes to modify, and cannot contain
* any primary key attributes.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateItemRequest withAttributeUpdates(java.util.Map attributeUpdates) {
setAttributeUpdates(attributeUpdates);
return this;
}
/**
* Designates an attribute for a conditional modification. The
* Expected parameter allows you to provide an attribute
* name, and whether or not Amazon DynamoDB should check to see if the
* attribute has a particular value before modifying it.
*
* @return Designates an attribute for a conditional modification. The
* Expected parameter allows you to provide an attribute
* name, and whether or not Amazon DynamoDB should check to see if the
* attribute has a particular value before modifying it.
*/
public java.util.Map getExpected() {
return expected;
}
/**
* Designates an attribute for a conditional modification. The
* Expected parameter allows you to provide an attribute
* name, and whether or not Amazon DynamoDB should check to see if the
* attribute has a particular value before modifying it.
*
* @param expected Designates an attribute for a conditional modification. The
* Expected parameter allows you to provide an attribute
* name, and whether or not Amazon DynamoDB should check to see if the
* attribute has a particular value before modifying it.
*/
public void setExpected(java.util.Map expected) {
this.expected = expected;
}
/**
* Designates an attribute for a conditional modification. The
* Expected parameter allows you to provide an attribute
* name, and whether or not Amazon DynamoDB should check to see if the
* attribute has a particular value before modifying it.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param expected Designates an attribute for a conditional modification. The
* Expected parameter allows you to provide an attribute
* name, and whether or not Amazon DynamoDB should check to see if the
* attribute has a particular value before modifying it.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateItemRequest withExpected(java.util.Map expected) {
setExpected(expected);
return this;
}
/**
* Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW. NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
*
* @return Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW.
NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* @see ReturnValue
*/
public String getReturnValues() {
return returnValues;
}
/**
* Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW. NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
*
* @param returnValues Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW.
NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* @see ReturnValue
*/
public void setReturnValues(String returnValues) {
this.returnValues = returnValues;
}
/**
* Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW. NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
*
* @param returnValues Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW.
NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ReturnValue
*/
public UpdateItemRequest withReturnValues(String returnValues) {
this.returnValues = returnValues;
return this;
}
/**
* Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW. NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
*
* @param returnValues Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW.
NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* @see ReturnValue
*/
public void setReturnValues(ReturnValue returnValues) {
this.returnValues = returnValues.toString();
}
/**
* Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW. NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
*
* @param returnValues Use this parameter if you want to get the attribute name-value pairs
* before or after they are modified. For PUT operations,
* the possible parameter values are NONE (default) or
* ALL_OLD. For update operations, the possible parameter
* values are NONE (default) or ALL_OLD,
* UPDATED_OLD, ALL_NEW or
* UPDATED_NEW.
NONE: Nothing is
* returned.ALL_OLD: Returns the attributes of the
* item as they were before the operation.UPDATED_OLD: Returns the values of the updated
* attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new
* values after the operation.UPDATED_NEW: Returns
* the values of the updated attributes, only, as they are after the
* operation.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ReturnValue
*/
public UpdateItemRequest withReturnValues(ReturnValue returnValues) {
this.returnValues = returnValues.toString();
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 (getTableName() != null) sb.append("TableName: " + getTableName() + ", ");
if (getKey() != null) sb.append("Key: " + getKey() + ", ");
if (getAttributeUpdates() != null) sb.append("AttributeUpdates: " + getAttributeUpdates() + ", ");
if (getExpected() != null) sb.append("Expected: " + getExpected() + ", ");
if (getReturnValues() != null) sb.append("ReturnValues: " + getReturnValues() + ", ");
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode());
hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode());
hashCode = prime * hashCode + ((getAttributeUpdates() == null) ? 0 : getAttributeUpdates().hashCode());
hashCode = prime * hashCode + ((getExpected() == null) ? 0 : getExpected().hashCode());
hashCode = prime * hashCode + ((getReturnValues() == null) ? 0 : getReturnValues().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof UpdateItemRequest == false) return false;
UpdateItemRequest other = (UpdateItemRequest)obj;
if (other.getTableName() == null ^ this.getTableName() == null) return false;
if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false) return false;
if (other.getKey() == null ^ this.getKey() == null) return false;
if (other.getKey() != null && other.getKey().equals(this.getKey()) == false) return false;
if (other.getAttributeUpdates() == null ^ this.getAttributeUpdates() == null) return false;
if (other.getAttributeUpdates() != null && other.getAttributeUpdates().equals(this.getAttributeUpdates()) == false) return false;
if (other.getExpected() == null ^ this.getExpected() == null) return false;
if (other.getExpected() != null && other.getExpected().equals(this.getExpected()) == false) return false;
if (other.getReturnValues() == null ^ this.getReturnValues() == null) return false;
if (other.getReturnValues() != null && other.getReturnValues().equals(this.getReturnValues()) == false) return false;
return true;
}
}