/* * Copyright 2010-2016 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; /** * <p> * Represents a condition to be compared with an attribute value. This condition * can be used with <i>DeleteItem</i>, <i>PutItem</i> or <i>UpdateItem</i> * operations; if the comparison evaluates to true, the operation succeeds; if * not, the operation fails. You can use <i>ExpectedAttributeValue</i> in one of * two different ways: * </p> * <ul> * <li> * <p> * Use <i>AttributeValueList</i> to specify one or more values to compare * against an attribute. Use <i>ComparisonOperator</i> to specify how you want * to perform the comparison. If the comparison evaluates to true, then the * conditional operation succeeds. * </p> * </li> * <li> * <p> * Use <i>Value</i> to specify a value that DynamoDB will compare against an * attribute. If the values match, then <i>ExpectedAttributeValue</i> evaluates * to true and the conditional operation succeeds. Optionally, you can also set * <i>Exists</i> to false, indicating that you <i>do not</i> expect to find the * attribute value in the table. In this case, the conditional operation * succeeds only if the comparison evaluates to false. * </p> * </li> * </ul> * <p> * <i>Value</i> and <i>Exists</i> are incompatible with * <i>AttributeValueList</i> and <i>ComparisonOperator</i>. Note that if you use * both sets of parameters at once, DynamoDB will return a * <i>ValidationException</i> exception. * </p> */ public class ExpectedAttributeValue implements Serializable { /** * <p> * Represents the data for an attribute. You can set one, and only one, of * the elements. * </p> * <p> * Each attribute in an item is a name-value pair. An attribute can be * single-valued or multi-valued set. For example, a book item can have * title and authors attributes. Each book has one title but can have many * authors. The multi-valued attribute is a set; duplicate values are not * allowed. * </p> */ private AttributeValue value; /** * <p> * Causes DynamoDB to evaluate the value before attempting a conditional * operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that * attribute value already exists in the table. If it is found, then the * operation succeeds. If it is not found, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the * attribute value does not exist in the table. If in fact the value does * not exist, then the assumption is valid and the operation succeeds. If * the value is found, despite the assumption that it does not exist, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If you supply * a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You * don't have to set <i>Exists</i> to <code>true</code>, because it is * implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. * (You expect a value to exist, but don't specify what that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a <i>Value</i>. * (You cannot expect an attribute to have a value, while also expecting it * not to exist.) * </p> * </li> * </ul> */ private Boolean exists; /** * <p> * A comparator for evaluating attributes in the <i>AttributeValueList</i>. * For example, equals, greater than, less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, * including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, Binary, String Set, Number Set, or Binary * Set. If an item contains an <i>AttributeValue</i> element of a different * type than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not equal * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, Binary, String Set, Number Set, or Binary Set. If an * item contains an <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code> * . * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, or Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one provided * in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its data type. * If the data type of attribute "<code>a</code>" is null, and you evaluate * it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This * result is because the attribute "<code>a</code>" exists; its data type is * not relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. <code>NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not its data * type. If the data type of attribute "<code>a</code>" is null, and you * evaluate it using <code>NULL</code>, the result is a Boolean * <i>false</i>. This is because the attribute "<code>a</code>" exists; its * data type is not relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is of type String, then the operator checks * for a substring match. If the target attribute of the comparison is of * type Binary, then the operator looks for a subsequence of the target that * matches the input. If the target attribute of the comparison is a set (" * <code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the * operator evaluates to true if it finds an exact match with any member of * the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, " * <code>b</code>" cannot be a set, a map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or * absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the comparison * is Binary, then the operator checks for the absence of a subsequence of * the target that matches the input. If the target attribute of the * comparison is a set ("<code>SS</code>", "<code>NS</code>", or " * <code>BS</code>"), then the operator evaluates to true if it <i>does * not</i> find an exact match with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a map, or a * list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String or Binary (not a Number or a set type). The target attribute * of the comparison must be of type String or Binary (not a Number or a set * type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> * elements of type String, Number, or Binary (not a set type). These * attributes are compared against an existing set type attribute of an * item. If any elements of the input set are present in the item attribute, * the expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first value, and less * than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements * of the same type, either String, Number, or Binary (not a set type). A * target attribute matches if the target value is greater than, or equal * to, the first element and less than, or equal to, the second element. If * an item contains an <i>AttributeValue</i> element of a different type * than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not compare to * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH */ private String comparisonOperator; /** * <p> * One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the <i>ComparisonOperator</i> being * used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, <code>a</code> is greater * than <code>A</code>, and <code>a</code> is greater than <code>B</code>. * For a list of code values, see <a * href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> */ private java.util.List<AttributeValue> attributeValueList; /** * Default constructor for ExpectedAttributeValue object. Callers should use * the setter or fluent setter (with...) methods to initialize any * additional object members. */ public ExpectedAttributeValue() { } /** * Constructs a new ExpectedAttributeValue object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. * * @param value <p> * Represents the data for an attribute. You can set one, and * only one, of the elements. * </p> * <p> * Each attribute in an item is a name-value pair. An attribute * can be single-valued or multi-valued set. For example, a book * item can have title and authors attributes. Each book has one * title but can have many authors. The multi-valued attribute is * a set; duplicate values are not allowed. * </p> */ public ExpectedAttributeValue(AttributeValue value) { setValue(value); } /** * Constructs a new ExpectedAttributeValue object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. * * @param exists <p> * Causes DynamoDB to evaluate the value before attempting a * conditional operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to * see if that attribute value already exists in the table. If it * is found, then the operation succeeds. If it is not found, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that * the attribute value does not exist in the table. If in fact * the value does not exist, then the assumption is valid and the * operation succeeds. If the value is found, despite the * assumption that it does not exist, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If * you supply a <i>Value</i> all by itself, DynamoDB assumes the * attribute exists: You don't have to set <i>Exists</i> to * <code>true</code>, because it is implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no * <i>Value</i> to check. (You expect a value to exist, but don't * specify what that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a * <i>Value</i>. (You cannot expect an attribute to have a value, * while also expecting it not to exist.) * </p> * </li> * </ul> */ public ExpectedAttributeValue(Boolean exists) { setExists(exists); } /** * <p> * Represents the data for an attribute. You can set one, and only one, of * the elements. * </p> * <p> * Each attribute in an item is a name-value pair. An attribute can be * single-valued or multi-valued set. For example, a book item can have * title and authors attributes. Each book has one title but can have many * authors. The multi-valued attribute is a set; duplicate values are not * allowed. * </p> * * @return <p> * Represents the data for an attribute. You can set one, and only * one, of the elements. * </p> * <p> * Each attribute in an item is a name-value pair. An attribute can * be single-valued or multi-valued set. For example, a book item * can have title and authors attributes. Each book has one title * but can have many authors. The multi-valued attribute is a set; * duplicate values are not allowed. * </p> */ public AttributeValue getValue() { return value; } /** * <p> * Represents the data for an attribute. You can set one, and only one, of * the elements. * </p> * <p> * Each attribute in an item is a name-value pair. An attribute can be * single-valued or multi-valued set. For example, a book item can have * title and authors attributes. Each book has one title but can have many * authors. The multi-valued attribute is a set; duplicate values are not * allowed. * </p> * * @param value <p> * Represents the data for an attribute. You can set one, and * only one, of the elements. * </p> * <p> * Each attribute in an item is a name-value pair. An attribute * can be single-valued or multi-valued set. For example, a book * item can have title and authors attributes. Each book has one * title but can have many authors. The multi-valued attribute is * a set; duplicate values are not allowed. * </p> */ public void setValue(AttributeValue value) { this.value = value; } /** * <p> * Represents the data for an attribute. You can set one, and only one, of * the elements. * </p> * <p> * Each attribute in an item is a name-value pair. An attribute can be * single-valued or multi-valued set. For example, a book item can have * title and authors attributes. Each book has one title but can have many * authors. The multi-valued attribute is a set; duplicate values are not * allowed. * </p> * <p> * Returns a reference to this object so that method calls can be chained * together. * * @param value <p> * Represents the data for an attribute. You can set one, and * only one, of the elements. * </p> * <p> * Each attribute in an item is a name-value pair. An attribute * can be single-valued or multi-valued set. For example, a book * item can have title and authors attributes. Each book has one * title but can have many authors. The multi-valued attribute is * a set; duplicate values are not allowed. * </p> * @return A reference to this updated object so that method calls can be * chained together. */ public ExpectedAttributeValue withValue(AttributeValue value) { this.value = value; return this; } /** * <p> * Causes DynamoDB to evaluate the value before attempting a conditional * operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that * attribute value already exists in the table. If it is found, then the * operation succeeds. If it is not found, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the * attribute value does not exist in the table. If in fact the value does * not exist, then the assumption is valid and the operation succeeds. If * the value is found, despite the assumption that it does not exist, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If you supply * a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You * don't have to set <i>Exists</i> to <code>true</code>, because it is * implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. * (You expect a value to exist, but don't specify what that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a <i>Value</i>. * (You cannot expect an attribute to have a value, while also expecting it * not to exist.) * </p> * </li> * </ul> * * @return <p> * Causes DynamoDB to evaluate the value before attempting a * conditional operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to see * if that attribute value already exists in the table. If it is * found, then the operation succeeds. If it is not found, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the * attribute value does not exist in the table. If in fact the value * does not exist, then the assumption is valid and the operation * succeeds. If the value is found, despite the assumption that it * does not exist, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If * you supply a <i>Value</i> all by itself, DynamoDB assumes the * attribute exists: You don't have to set <i>Exists</i> to * <code>true</code>, because it is implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no <i>Value</i> * to check. (You expect a value to exist, but don't specify what * that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a * <i>Value</i>. (You cannot expect an attribute to have a value, * while also expecting it not to exist.) * </p> * </li> * </ul> */ public Boolean isExists() { return exists; } /** * <p> * Causes DynamoDB to evaluate the value before attempting a conditional * operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that * attribute value already exists in the table. If it is found, then the * operation succeeds. If it is not found, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the * attribute value does not exist in the table. If in fact the value does * not exist, then the assumption is valid and the operation succeeds. If * the value is found, despite the assumption that it does not exist, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If you supply * a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You * don't have to set <i>Exists</i> to <code>true</code>, because it is * implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. * (You expect a value to exist, but don't specify what that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a <i>Value</i>. * (You cannot expect an attribute to have a value, while also expecting it * not to exist.) * </p> * </li> * </ul> * * @return <p> * Causes DynamoDB to evaluate the value before attempting a * conditional operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to see * if that attribute value already exists in the table. If it is * found, then the operation succeeds. If it is not found, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the * attribute value does not exist in the table. If in fact the value * does not exist, then the assumption is valid and the operation * succeeds. If the value is found, despite the assumption that it * does not exist, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If * you supply a <i>Value</i> all by itself, DynamoDB assumes the * attribute exists: You don't have to set <i>Exists</i> to * <code>true</code>, because it is implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no <i>Value</i> * to check. (You expect a value to exist, but don't specify what * that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a * <i>Value</i>. (You cannot expect an attribute to have a value, * while also expecting it not to exist.) * </p> * </li> * </ul> */ public Boolean getExists() { return exists; } /** * <p> * Causes DynamoDB to evaluate the value before attempting a conditional * operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that * attribute value already exists in the table. If it is found, then the * operation succeeds. If it is not found, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the * attribute value does not exist in the table. If in fact the value does * not exist, then the assumption is valid and the operation succeeds. If * the value is found, despite the assumption that it does not exist, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If you supply * a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You * don't have to set <i>Exists</i> to <code>true</code>, because it is * implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. * (You expect a value to exist, but don't specify what that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a <i>Value</i>. * (You cannot expect an attribute to have a value, while also expecting it * not to exist.) * </p> * </li> * </ul> * * @param exists <p> * Causes DynamoDB to evaluate the value before attempting a * conditional operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to * see if that attribute value already exists in the table. If it * is found, then the operation succeeds. If it is not found, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that * the attribute value does not exist in the table. If in fact * the value does not exist, then the assumption is valid and the * operation succeeds. If the value is found, despite the * assumption that it does not exist, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If * you supply a <i>Value</i> all by itself, DynamoDB assumes the * attribute exists: You don't have to set <i>Exists</i> to * <code>true</code>, because it is implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no * <i>Value</i> to check. (You expect a value to exist, but don't * specify what that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a * <i>Value</i>. (You cannot expect an attribute to have a value, * while also expecting it not to exist.) * </p> * </li> * </ul> */ public void setExists(Boolean exists) { this.exists = exists; } /** * <p> * Causes DynamoDB to evaluate the value before attempting a conditional * operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that * attribute value already exists in the table. If it is found, then the * operation succeeds. If it is not found, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the * attribute value does not exist in the table. If in fact the value does * not exist, then the assumption is valid and the operation succeeds. If * the value is found, despite the assumption that it does not exist, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If you supply * a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You * don't have to set <i>Exists</i> to <code>true</code>, because it is * implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. * (You expect a value to exist, but don't specify what that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a <i>Value</i>. * (You cannot expect an attribute to have a value, while also expecting it * not to exist.) * </p> * </li> * </ul> * <p> * Returns a reference to this object so that method calls can be chained * together. * * @param exists <p> * Causes DynamoDB to evaluate the value before attempting a * conditional operation: * </p> * <ul> * <li> * <p> * If <i>Exists</i> is <code>true</code>, DynamoDB will check to * see if that attribute value already exists in the table. If it * is found, then the operation succeeds. If it is not found, the * operation fails with a <i>ConditionalCheckFailedException</i>. * </p> * </li> * <li> * <p> * If <i>Exists</i> is <code>false</code>, DynamoDB assumes that * the attribute value does not exist in the table. If in fact * the value does not exist, then the assumption is valid and the * operation succeeds. If the value is found, despite the * assumption that it does not exist, the operation fails with a * <i>ConditionalCheckFailedException</i>. * </p> * </li> * </ul> * <p> * The default setting for <i>Exists</i> is <code>true</code>. If * you supply a <i>Value</i> all by itself, DynamoDB assumes the * attribute exists: You don't have to set <i>Exists</i> to * <code>true</code>, because it is implied. * </p> * <p> * DynamoDB returns a <i>ValidationException</i> if: * </p> * <ul> * <li> * <p> * <i>Exists</i> is <code>true</code> but there is no * <i>Value</i> to check. (You expect a value to exist, but don't * specify what that value is.) * </p> * </li> * <li> * <p> * <i>Exists</i> is <code>false</code> but you also provide a * <i>Value</i>. (You cannot expect an attribute to have a value, * while also expecting it not to exist.) * </p> * </li> * </ul> * @return A reference to this updated object so that method calls can be * chained together. */ public ExpectedAttributeValue withExists(Boolean exists) { this.exists = exists; return this; } /** * <p> * A comparator for evaluating attributes in the <i>AttributeValueList</i>. * For example, equals, greater than, less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, * including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, Binary, String Set, Number Set, or Binary * Set. If an item contains an <i>AttributeValue</i> element of a different * type than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not equal * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, Binary, String Set, Number Set, or Binary Set. If an * item contains an <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code> * . * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, or Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one provided * in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its data type. * If the data type of attribute "<code>a</code>" is null, and you evaluate * it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This * result is because the attribute "<code>a</code>" exists; its data type is * not relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. <code>NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not its data * type. If the data type of attribute "<code>a</code>" is null, and you * evaluate it using <code>NULL</code>, the result is a Boolean * <i>false</i>. This is because the attribute "<code>a</code>" exists; its * data type is not relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is of type String, then the operator checks * for a substring match. If the target attribute of the comparison is of * type Binary, then the operator looks for a subsequence of the target that * matches the input. If the target attribute of the comparison is a set (" * <code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the * operator evaluates to true if it finds an exact match with any member of * the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, " * <code>b</code>" cannot be a set, a map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or * absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the comparison * is Binary, then the operator checks for the absence of a subsequence of * the target that matches the input. If the target attribute of the * comparison is a set ("<code>SS</code>", "<code>NS</code>", or " * <code>BS</code>"), then the operator evaluates to true if it <i>does * not</i> find an exact match with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a map, or a * list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String or Binary (not a Number or a set type). The target attribute * of the comparison must be of type String or Binary (not a Number or a set * type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> * elements of type String, Number, or Binary (not a set type). These * attributes are compared against an existing set type attribute of an * item. If any elements of the input set are present in the item attribute, * the expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first value, and less * than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements * of the same type, either String, Number, or Binary (not a set type). A * target attribute matches if the target value is greater than, or equal * to, the first element and less than, or equal to, the second element. If * an item contains an <i>AttributeValue</i> element of a different type * than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not compare to * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @return <p> * A comparator for evaluating attributes in the * <i>AttributeValueList</i>. For example, equals, greater than, * less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, Binary, * String Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not equal * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> of a different type than the one provided * in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not equal * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or Binary * (not a set type). If an item contains an <i>AttributeValue</i> * element of a different type than the one provided in the request, * the value does not match. For example, <code>{"S":"6"}</code> * does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, or Binary (not a * set type). If an item contains an <i>AttributeValue</i> element * of a different type than the one provided in the request, the * value does not match. For example, <code>{"S":"6"}</code> does * not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> * does not compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or Binary * (not a set type). If an item contains an <i>AttributeValue</i> * element of a different type than the one provided in the request, * the value does not match. For example, <code>{"S":"6"}</code> * does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or Binary * (not a set type). If an item contains an <i>AttributeValue</i> * element of a different type than the one provided in the request, * the value does not match. For example, <code>{"S":"6"}</code> * does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. * <code>NOT_NULL</code> is supported for all datatypes, including * lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its * data type. If the data type of attribute "<code>a</code>" is * null, and you evaluate it using <code>NOT_NULL</code>, the result * is a Boolean <i>true</i>. This result is because the attribute " * <code>a</code>" exists; its data type is not relevant to the * <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. * <code>NULL</code> is supported for all datatypes, including lists * and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not its * data type. If the data type of attribute "<code>a</code>" is * null, and you evaluate it using <code>NULL</code>, the result is * a Boolean <i>false</i>. This is because the attribute " * <code>a</code>" exists; its data type is not relevant to the * <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in a * set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or Binary * (not a set type). If the target attribute of the comparison is of * type String, then the operator checks for a substring match. If * the target attribute of the comparison is of type Binary, then * the operator looks for a subsequence of the target that matches * the input. If the target attribute of the comparison is a set (" * <code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then * the operator evaluates to true if it finds an exact match with * any member of the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, * or absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or Binary * (not a set type). If the target attribute of the comparison is a * String, then the operator checks for the absence of a substring * match. If the target attribute of the comparison is Binary, then * the operator checks for the absence of a subsequence of the * target that matches the input. If the target attribute of the * comparison is a set ("<code>SS</code>", "<code>NS</code>", or " * <code>BS</code>"), then the operator evaluates to true if it * <i>does not</i> find an exact match with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String or Binary (not a Number or a * set type). The target attribute of the comparison must be of type * String or Binary (not a Number or a set type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more * <i>AttributeValue</i> elements of type String, Number, or Binary * (not a set type). These attributes are compared against an * existing set type attribute of an item. If any elements of the * input set are present in the item attribute, the expression * evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first value, * and less than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two <i>AttributeValue</i> * elements of the same type, either String, Number, or Binary (not * a set type). A target attribute matches if the target value is * greater than, or equal to, the first element and less than, or * equal to, the second element. If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code> * . Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * @see ComparisonOperator */ public String getComparisonOperator() { return comparisonOperator; } /** * <p> * A comparator for evaluating attributes in the <i>AttributeValueList</i>. * For example, equals, greater than, less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, * including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, Binary, String Set, Number Set, or Binary * Set. If an item contains an <i>AttributeValue</i> element of a different * type than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not equal * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, Binary, String Set, Number Set, or Binary Set. If an * item contains an <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code> * . * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, or Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one provided * in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its data type. * If the data type of attribute "<code>a</code>" is null, and you evaluate * it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This * result is because the attribute "<code>a</code>" exists; its data type is * not relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. <code>NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not its data * type. If the data type of attribute "<code>a</code>" is null, and you * evaluate it using <code>NULL</code>, the result is a Boolean * <i>false</i>. This is because the attribute "<code>a</code>" exists; its * data type is not relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is of type String, then the operator checks * for a substring match. If the target attribute of the comparison is of * type Binary, then the operator looks for a subsequence of the target that * matches the input. If the target attribute of the comparison is a set (" * <code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the * operator evaluates to true if it finds an exact match with any member of * the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, " * <code>b</code>" cannot be a set, a map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or * absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the comparison * is Binary, then the operator checks for the absence of a subsequence of * the target that matches the input. If the target attribute of the * comparison is a set ("<code>SS</code>", "<code>NS</code>", or " * <code>BS</code>"), then the operator evaluates to true if it <i>does * not</i> find an exact match with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a map, or a * list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String or Binary (not a Number or a set type). The target attribute * of the comparison must be of type String or Binary (not a Number or a set * type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> * elements of type String, Number, or Binary (not a set type). These * attributes are compared against an existing set type attribute of an * item. If any elements of the input set are present in the item attribute, * the expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first value, and less * than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements * of the same type, either String, Number, or Binary (not a set type). A * target attribute matches if the target value is greater than, or equal * to, the first element and less than, or equal to, the second element. If * an item contains an <i>AttributeValue</i> element of a different type * than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not compare to * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @param comparisonOperator <p> * A comparator for evaluating attributes in the * <i>AttributeValueList</i>. For example, equals, greater than, * less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, Binary, * String Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * equal <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for * all datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * equal <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, or Binary (not a * set type). If an item contains an <i>AttributeValue</i> * element of a different type than the one provided in the * request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. * <code>NOT_NULL</code> is supported for all datatypes, * including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its * data type. If the data type of attribute "<code>a</code>" is * null, and you evaluate it using <code>NOT_NULL</code>, the * result is a Boolean <i>true</i>. This result is because the * attribute "<code>a</code>" exists; its data type is not * relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. * <code>NULL</code> is supported for all datatypes, including * lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not * its data type. If the data type of attribute "<code>a</code>" * is null, and you evaluate it using <code>NULL</code>, the * result is a Boolean <i>false</i>. This is because the * attribute "<code>a</code>" exists; its data type is not * relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in * a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If the target attribute of the * comparison is of type String, then the operator checks for a * substring match. If the target attribute of the comparison is * of type Binary, then the operator looks for a subsequence of * the target that matches the input. If the target attribute of * the comparison is a set ("<code>SS</code>", "<code>NS</code> * ", or "<code>BS</code>"), then the operator evaluates to true * if it finds an exact match with any member of the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a * subsequence, or absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If the target attribute of the * comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the * comparison is Binary, then the operator checks for the absence * of a subsequence of the target that matches the input. If the * target attribute of the comparison is a set ("<code>SS</code> * ", "<code>NS</code>", or "<code>BS</code>"), then the operator * evaluates to true if it <i>does not</i> find an exact match * with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String or Binary (not a Number * or a set type). The target attribute of the comparison must be * of type String or Binary (not a Number or a set type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two * sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more * <i>AttributeValue</i> elements of type String, Number, or * Binary (not a set type). These attributes are compared against * an existing set type attribute of an item. If any elements of * the input set are present in the item attribute, the * expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first * value, and less than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two * <i>AttributeValue</i> elements of the same type, either * String, Number, or Binary (not a set type). A target attribute * matches if the target value is greater than, or equal to, the * first element and less than, or equal to, the second element. * If an item contains an <i>AttributeValue</i> element of a * different type than the one provided in the request, the value * does not match. For example, <code>{"S":"6"}</code> does not * compare to <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * @see ComparisonOperator */ public void setComparisonOperator(String comparisonOperator) { this.comparisonOperator = comparisonOperator; } /** * <p> * A comparator for evaluating attributes in the <i>AttributeValueList</i>. * For example, equals, greater than, less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, * including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, Binary, String Set, Number Set, or Binary * Set. If an item contains an <i>AttributeValue</i> element of a different * type than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not equal * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, Binary, String Set, Number Set, or Binary Set. If an * item contains an <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code> * . * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, or Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one provided * in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its data type. * If the data type of attribute "<code>a</code>" is null, and you evaluate * it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This * result is because the attribute "<code>a</code>" exists; its data type is * not relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. <code>NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not its data * type. If the data type of attribute "<code>a</code>" is null, and you * evaluate it using <code>NULL</code>, the result is a Boolean * <i>false</i>. This is because the attribute "<code>a</code>" exists; its * data type is not relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is of type String, then the operator checks * for a substring match. If the target attribute of the comparison is of * type Binary, then the operator looks for a subsequence of the target that * matches the input. If the target attribute of the comparison is a set (" * <code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the * operator evaluates to true if it finds an exact match with any member of * the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, " * <code>b</code>" cannot be a set, a map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or * absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the comparison * is Binary, then the operator checks for the absence of a subsequence of * the target that matches the input. If the target attribute of the * comparison is a set ("<code>SS</code>", "<code>NS</code>", or " * <code>BS</code>"), then the operator evaluates to true if it <i>does * not</i> find an exact match with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a map, or a * list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String or Binary (not a Number or a set type). The target attribute * of the comparison must be of type String or Binary (not a Number or a set * type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> * elements of type String, Number, or Binary (not a set type). These * attributes are compared against an existing set type attribute of an * item. If any elements of the input set are present in the item attribute, * the expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first value, and less * than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements * of the same type, either String, Number, or Binary (not a set type). A * target attribute matches if the target value is greater than, or equal * to, the first element and less than, or equal to, the second element. If * an item contains an <i>AttributeValue</i> element of a different type * than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not compare to * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * <p> * Returns a reference to this object so that method calls can be chained * together. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @param comparisonOperator <p> * A comparator for evaluating attributes in the * <i>AttributeValueList</i>. For example, equals, greater than, * less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, Binary, * String Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * equal <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for * all datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * equal <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, or Binary (not a * set type). If an item contains an <i>AttributeValue</i> * element of a different type than the one provided in the * request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. * <code>NOT_NULL</code> is supported for all datatypes, * including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its * data type. If the data type of attribute "<code>a</code>" is * null, and you evaluate it using <code>NOT_NULL</code>, the * result is a Boolean <i>true</i>. This result is because the * attribute "<code>a</code>" exists; its data type is not * relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. * <code>NULL</code> is supported for all datatypes, including * lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not * its data type. If the data type of attribute "<code>a</code>" * is null, and you evaluate it using <code>NULL</code>, the * result is a Boolean <i>false</i>. This is because the * attribute "<code>a</code>" exists; its data type is not * relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in * a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If the target attribute of the * comparison is of type String, then the operator checks for a * substring match. If the target attribute of the comparison is * of type Binary, then the operator looks for a subsequence of * the target that matches the input. If the target attribute of * the comparison is a set ("<code>SS</code>", "<code>NS</code> * ", or "<code>BS</code>"), then the operator evaluates to true * if it finds an exact match with any member of the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a * subsequence, or absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If the target attribute of the * comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the * comparison is Binary, then the operator checks for the absence * of a subsequence of the target that matches the input. If the * target attribute of the comparison is a set ("<code>SS</code> * ", "<code>NS</code>", or "<code>BS</code>"), then the operator * evaluates to true if it <i>does not</i> find an exact match * with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String or Binary (not a Number * or a set type). The target attribute of the comparison must be * of type String or Binary (not a Number or a set type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two * sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more * <i>AttributeValue</i> elements of type String, Number, or * Binary (not a set type). These attributes are compared against * an existing set type attribute of an item. If any elements of * the input set are present in the item attribute, the * expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first * value, and less than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two * <i>AttributeValue</i> elements of the same type, either * String, Number, or Binary (not a set type). A target attribute * matches if the target value is greater than, or equal to, the * first element and less than, or equal to, the second element. * If an item contains an <i>AttributeValue</i> element of a * different type than the one provided in the request, the value * does not match. For example, <code>{"S":"6"}</code> does not * compare to <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * @return A reference to this updated object so that method calls can be * chained together. * @see ComparisonOperator */ public ExpectedAttributeValue withComparisonOperator(String comparisonOperator) { this.comparisonOperator = comparisonOperator; return this; } /** * <p> * A comparator for evaluating attributes in the <i>AttributeValueList</i>. * For example, equals, greater than, less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, * including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, Binary, String Set, Number Set, or Binary * Set. If an item contains an <i>AttributeValue</i> element of a different * type than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not equal * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, Binary, String Set, Number Set, or Binary Set. If an * item contains an <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code> * . * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, or Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one provided * in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its data type. * If the data type of attribute "<code>a</code>" is null, and you evaluate * it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This * result is because the attribute "<code>a</code>" exists; its data type is * not relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. <code>NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not its data * type. If the data type of attribute "<code>a</code>" is null, and you * evaluate it using <code>NULL</code>, the result is a Boolean * <i>false</i>. This is because the attribute "<code>a</code>" exists; its * data type is not relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is of type String, then the operator checks * for a substring match. If the target attribute of the comparison is of * type Binary, then the operator looks for a subsequence of the target that * matches the input. If the target attribute of the comparison is a set (" * <code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the * operator evaluates to true if it finds an exact match with any member of * the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, " * <code>b</code>" cannot be a set, a map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or * absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the comparison * is Binary, then the operator checks for the absence of a subsequence of * the target that matches the input. If the target attribute of the * comparison is a set ("<code>SS</code>", "<code>NS</code>", or " * <code>BS</code>"), then the operator evaluates to true if it <i>does * not</i> find an exact match with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a map, or a * list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String or Binary (not a Number or a set type). The target attribute * of the comparison must be of type String or Binary (not a Number or a set * type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> * elements of type String, Number, or Binary (not a set type). These * attributes are compared against an existing set type attribute of an * item. If any elements of the input set are present in the item attribute, * the expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first value, and less * than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements * of the same type, either String, Number, or Binary (not a set type). A * target attribute matches if the target value is greater than, or equal * to, the first element and less than, or equal to, the second element. If * an item contains an <i>AttributeValue</i> element of a different type * than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not compare to * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @param comparisonOperator <p> * A comparator for evaluating attributes in the * <i>AttributeValueList</i>. For example, equals, greater than, * less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, Binary, * String Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * equal <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for * all datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * equal <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, or Binary (not a * set type). If an item contains an <i>AttributeValue</i> * element of a different type than the one provided in the * request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. * <code>NOT_NULL</code> is supported for all datatypes, * including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its * data type. If the data type of attribute "<code>a</code>" is * null, and you evaluate it using <code>NOT_NULL</code>, the * result is a Boolean <i>true</i>. This result is because the * attribute "<code>a</code>" exists; its data type is not * relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. * <code>NULL</code> is supported for all datatypes, including * lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not * its data type. If the data type of attribute "<code>a</code>" * is null, and you evaluate it using <code>NULL</code>, the * result is a Boolean <i>false</i>. This is because the * attribute "<code>a</code>" exists; its data type is not * relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in * a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If the target attribute of the * comparison is of type String, then the operator checks for a * substring match. If the target attribute of the comparison is * of type Binary, then the operator looks for a subsequence of * the target that matches the input. If the target attribute of * the comparison is a set ("<code>SS</code>", "<code>NS</code> * ", or "<code>BS</code>"), then the operator evaluates to true * if it finds an exact match with any member of the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a * subsequence, or absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If the target attribute of the * comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the * comparison is Binary, then the operator checks for the absence * of a subsequence of the target that matches the input. If the * target attribute of the comparison is a set ("<code>SS</code> * ", "<code>NS</code>", or "<code>BS</code>"), then the operator * evaluates to true if it <i>does not</i> find an exact match * with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String or Binary (not a Number * or a set type). The target attribute of the comparison must be * of type String or Binary (not a Number or a set type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two * sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more * <i>AttributeValue</i> elements of type String, Number, or * Binary (not a set type). These attributes are compared against * an existing set type attribute of an item. If any elements of * the input set are present in the item attribute, the * expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first * value, and less than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two * <i>AttributeValue</i> elements of the same type, either * String, Number, or Binary (not a set type). A target attribute * matches if the target value is greater than, or equal to, the * first element and less than, or equal to, the second element. * If an item contains an <i>AttributeValue</i> element of a * different type than the one provided in the request, the value * does not match. For example, <code>{"S":"6"}</code> does not * compare to <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * @see ComparisonOperator */ public void setComparisonOperator(ComparisonOperator comparisonOperator) { this.comparisonOperator = comparisonOperator.toString(); } /** * <p> * A comparator for evaluating attributes in the <i>AttributeValueList</i>. * For example, equals, greater than, less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, * including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, Binary, String Set, Number Set, or Binary * Set. If an item contains an <i>AttributeValue</i> element of a different * type than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not equal * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, Binary, String Set, Number Set, or Binary Set. If an * item contains an <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code> * . * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String, Number, or Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one provided * in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If an item * contains an <i>AttributeValue</i> element of a different type than the * one provided in the request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its data type. * If the data type of attribute "<code>a</code>" is null, and you evaluate * it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This * result is because the attribute "<code>a</code>" exists; its data type is * not relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. <code>NULL</code> is * supported for all datatypes, including lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not its data * type. If the data type of attribute "<code>a</code>" is null, and you * evaluate it using <code>NULL</code>, the result is a Boolean * <i>false</i>. This is because the attribute "<code>a</code>" exists; its * data type is not relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is of type String, then the operator checks * for a substring match. If the target attribute of the comparison is of * type Binary, then the operator looks for a subsequence of the target that * matches the input. If the target attribute of the comparison is a set (" * <code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the * operator evaluates to true if it finds an exact match with any member of * the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, " * <code>b</code>" cannot be a set, a map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or * absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> * element of type String, Number, or Binary (not a set type). If the target * attribute of the comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the comparison * is Binary, then the operator checks for the absence of a subsequence of * the target that matches the input. If the target attribute of the * comparison is a set ("<code>SS</code>", "<code>NS</code>", or " * <code>BS</code>"), then the operator evaluates to true if it <i>does * not</i> find an exact match with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a map, or a * list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of * type String or Binary (not a Number or a set type). The target attribute * of the comparison must be of type String or Binary (not a Number or a set * type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> * elements of type String, Number, or Binary (not a set type). These * attributes are compared against an existing set type attribute of an * item. If any elements of the input set are present in the item attribute, * the expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first value, and less * than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements * of the same type, either String, Number, or Binary (not a set type). A * target attribute matches if the target value is greater than, or equal * to, the first element and less than, or equal to, the second element. If * an item contains an <i>AttributeValue</i> element of a different type * than the one provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not compare to * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * <p> * Returns a reference to this object so that method calls can be chained * together. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @param comparisonOperator <p> * A comparator for evaluating attributes in the * <i>AttributeValueList</i>. For example, equals, greater than, * less than, etc. * </p> * <p> * The following comparison operators are available: * </p> * <p> * <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> * </p> * <p> * The following are descriptions of each comparison operator. * </p> * <ul> * <li> * <p> * <code>EQ</code> : Equal. <code>EQ</code> is supported for all * datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, Binary, * String Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * equal <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NE</code> : Not equal. <code>NE</code> is supported for * all datatypes, including lists and maps. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * <i>AttributeValue</i> of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * equal <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LE</code> : Less than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>LT</code> : Less than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String, Number, or Binary (not a * set type). If an item contains an <i>AttributeValue</i> * element of a different type than the one provided in the * request, the value does not match. For example, * <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. * Also, <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GE</code> : Greater than or equal. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>GT</code> : Greater than. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If an item contains an * <i>AttributeValue</i> element of a different type than the one * provided in the request, the value does not match. For * example, <code>{"S":"6"}</code> does not equal * <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not * compare to <code>{"NS":["6", "2", "1"]}</code>. * </p> * <p/></li> * <li> * <p> * <code>NOT_NULL</code> : The attribute exists. * <code>NOT_NULL</code> is supported for all datatypes, * including lists and maps. * </p> * <note> * <p> * This operator tests for the existence of an attribute, not its * data type. If the data type of attribute "<code>a</code>" is * null, and you evaluate it using <code>NOT_NULL</code>, the * result is a Boolean <i>true</i>. This result is because the * attribute "<code>a</code>" exists; its data type is not * relevant to the <code>NOT_NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>NULL</code> : The attribute does not exist. * <code>NULL</code> is supported for all datatypes, including * lists and maps. * </p> * <note> * <p> * This operator tests for the nonexistence of an attribute, not * its data type. If the data type of attribute "<code>a</code>" * is null, and you evaluate it using <code>NULL</code>, the * result is a Boolean <i>false</i>. This is because the * attribute "<code>a</code>" exists; its data type is not * relevant to the <code>NULL</code> comparison operator. * </p> * </note></li> * <li> * <p> * <code>CONTAINS</code> : Checks for a subsequence, or value in * a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If the target attribute of the * comparison is of type String, then the operator checks for a * substring match. If the target attribute of the comparison is * of type Binary, then the operator looks for a subsequence of * the target that matches the input. If the target attribute of * the comparison is a set ("<code>SS</code>", "<code>NS</code> * ", or "<code>BS</code>"), then the operator evaluates to true * if it finds an exact match with any member of the set. * </p> * <p> * CONTAINS is supported for lists: When evaluating " * <code>a CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>NOT_CONTAINS</code> : Checks for absence of a * subsequence, or absence of a value in a set. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> element of type String, Number, or * Binary (not a set type). If the target attribute of the * comparison is a String, then the operator checks for the * absence of a substring match. If the target attribute of the * comparison is Binary, then the operator checks for the absence * of a subsequence of the target that matches the input. If the * target attribute of the comparison is a set ("<code>SS</code> * ", "<code>NS</code>", or "<code>BS</code>"), then the operator * evaluates to true if it <i>does not</i> find an exact match * with any member of the set. * </p> * <p> * NOT_CONTAINS is supported for lists: When evaluating " * <code>a NOT CONTAINS b</code>", "<code>a</code> * " can be a list; however, "<code>b</code>" cannot be a set, a * map, or a list. * </p> * </li> * <li> * <p> * <code>BEGINS_WITH</code> : Checks for a prefix. * </p> * <p> * <i>AttributeValueList</i> can contain only one * <i>AttributeValue</i> of type String or Binary (not a Number * or a set type). The target attribute of the comparison must be * of type String or Binary (not a Number or a set type). * </p> * <p/></li> * <li> * <p> * <code>IN</code> : Checks for matching elements within two * sets. * </p> * <p> * <i>AttributeValueList</i> can contain one or more * <i>AttributeValue</i> elements of type String, Number, or * Binary (not a set type). These attributes are compared against * an existing set type attribute of an item. If any elements of * the input set are present in the item attribute, the * expression evaluates to true. * </p> * </li> * <li> * <p> * <code>BETWEEN</code> : Greater than or equal to the first * value, and less than or equal to the second value. * </p> * <p> * <i>AttributeValueList</i> must contain two * <i>AttributeValue</i> elements of the same type, either * String, Number, or Binary (not a set type). A target attribute * matches if the target value is greater than, or equal to, the * first element and less than, or equal to, the second element. * If an item contains an <i>AttributeValue</i> element of a * different type than the one provided in the request, the value * does not match. For example, <code>{"S":"6"}</code> does not * compare to <code>{"N":"6"}</code>. Also, * <code>{"N":"6"}</code> does not compare to * <code>{"NS":["6", "2", "1"]}</code> * </p> * </li> * </ul> * @return A reference to this updated object so that method calls can be * chained together. * @see ComparisonOperator */ public ExpectedAttributeValue withComparisonOperator(ComparisonOperator comparisonOperator) { this.comparisonOperator = comparisonOperator.toString(); return this; } /** * <p> * One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the <i>ComparisonOperator</i> being * used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, <code>a</code> is greater * than <code>A</code>, and <code>a</code> is greater than <code>B</code>. * For a list of code values, see <a * href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @return <p> * One or more values to evaluate against the supplied attribute. * The number of values in the list depends on the * <i>ComparisonOperator</i> being used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less than * are based on ASCII character code values. For example, * <code>a</code> is greater than <code>A</code>, and <code>a</code> * is greater than <code>B</code>. For a list of code values, see <a * href * ="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http * ://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer * Guide</i>. * </p> */ public java.util.List<AttributeValue> getAttributeValueList() { return attributeValueList; } /** * <p> * One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the <i>ComparisonOperator</i> being * used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, <code>a</code> is greater * than <code>A</code>, and <code>a</code> is greater than <code>B</code>. * For a list of code values, see <a * href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @param attributeValueList <p> * One or more values to evaluate against the supplied attribute. * The number of values in the list depends on the * <i>ComparisonOperator</i> being used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less * than are based on ASCII character code values. For example, * <code>a</code> is greater than <code>A</code>, and * <code>a</code> is greater than <code>B</code>. For a list of * code values, see <a href= * "http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters * </a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer * Guide</i>. * </p> */ public void setAttributeValueList(java.util.Collection<AttributeValue> attributeValueList) { if (attributeValueList == null) { this.attributeValueList = null; return; } this.attributeValueList = new java.util.ArrayList<AttributeValue>(attributeValueList); } /** * <p> * One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the <i>ComparisonOperator</i> being * used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, <code>a</code> is greater * than <code>A</code>, and <code>a</code> is greater than <code>B</code>. * For a list of code values, see <a * href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * Returns a reference to this object so that method calls can be chained * together. * * @param attributeValueList <p> * One or more values to evaluate against the supplied attribute. * The number of values in the list depends on the * <i>ComparisonOperator</i> being used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less * than are based on ASCII character code values. For example, * <code>a</code> is greater than <code>A</code>, and * <code>a</code> is greater than <code>B</code>. For a list of * code values, see <a href= * "http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters * </a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer * Guide</i>. * </p> * @return A reference to this updated object so that method calls can be * chained together. */ public ExpectedAttributeValue withAttributeValueList(AttributeValue... attributeValueList) { if (getAttributeValueList() == null) { this.attributeValueList = new java.util.ArrayList<AttributeValue>( attributeValueList.length); } for (AttributeValue value : attributeValueList) { this.attributeValueList.add(value); } return this; } /** * <p> * One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the <i>ComparisonOperator</i> being * used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, <code>a</code> is greater * than <code>A</code>, and <code>a</code> is greater than <code>B</code>. * For a list of code values, see <a * href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * Returns a reference to this object so that method calls can be chained * together. * * @param attributeValueList <p> * One or more values to evaluate against the supplied attribute. * The number of values in the list depends on the * <i>ComparisonOperator</i> being used. * </p> * <p> * For type Number, value comparisons are numeric. * </p> * <p> * String value comparisons for greater than, equals, or less * than are based on ASCII character code values. For example, * <code>a</code> is greater than <code>A</code>, and * <code>a</code> is greater than <code>B</code>. For a list of * code values, see <a href= * "http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" * >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters * </a>. * </p> * <p> * For Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values. * </p> * <p> * For information on specifying data types in JSON, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html" * >JSON Data Format</a> in the <i>Amazon DynamoDB Developer * Guide</i>. * </p> * @return A reference to this updated object so that method calls can be * chained together. */ public ExpectedAttributeValue withAttributeValueList( java.util.Collection<AttributeValue> attributeValueList) { setAttributeValueList(attributeValueList); 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 (getValue() != null) sb.append("Value: " + getValue() + ","); if (getExists() != null) sb.append("Exists: " + getExists() + ","); if (getComparisonOperator() != null) sb.append("ComparisonOperator: " + getComparisonOperator() + ","); if (getAttributeValueList() != null) sb.append("AttributeValueList: " + getAttributeValueList()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode()); hashCode = prime * hashCode + ((getExists() == null) ? 0 : getExists().hashCode()); hashCode = prime * hashCode + ((getComparisonOperator() == null) ? 0 : getComparisonOperator().hashCode()); hashCode = prime * hashCode + ((getAttributeValueList() == null) ? 0 : getAttributeValueList().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ExpectedAttributeValue == false) return false; ExpectedAttributeValue other = (ExpectedAttributeValue) obj; if (other.getValue() == null ^ this.getValue() == null) return false; if (other.getValue() != null && other.getValue().equals(this.getValue()) == false) return false; if (other.getExists() == null ^ this.getExists() == null) return false; if (other.getExists() != null && other.getExists().equals(this.getExists()) == false) return false; if (other.getComparisonOperator() == null ^ this.getComparisonOperator() == null) return false; if (other.getComparisonOperator() != null && other.getComparisonOperator().equals(this.getComparisonOperator()) == false) return false; if (other.getAttributeValueList() == null ^ this.getAttributeValueList() == null) return false; if (other.getAttributeValueList() != null && other.getAttributeValueList().equals(this.getAttributeValueList()) == false) return false; return true; } }