All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.dynamodbv2.model.DeleteItemRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon DynamoDB module holds the client classes that are used for communicating with Amazon DynamoDB Service

There is a newer version: 1.12.765
Show newest version
/*
 * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.dynamodbv2.model;

import java.io.Serializable;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * Container for the parameters to the {@link com.amazonaws.services.dynamodbv2.AmazonDynamoDB#deleteItem(DeleteItemRequest) DeleteItem operation}.
 * 

* Deletes a single item in a table by primary key. You can perform a * conditional delete operation that deletes the item if it exists, or if * it has an expected attribute value. *

*

* In addition to deleting an item, you can also return the item's * attribute values in the same operation, using the ReturnValues * parameter. *

*

* Unless you specify conditions, the DeleteItem is an idempotent * operation; running it multiple times on the same item or attribute * does not result in an error response. *

*

* Conditional deletes are useful for deleting items only if specific * conditions are met. If those conditions are met, DynamoDB performs the * delete. Otherwise, the item is not deleted. *

* * @see com.amazonaws.services.dynamodbv2.AmazonDynamoDB#deleteItem(DeleteItemRequest) */ public class DeleteItemRequest extends AmazonWebServiceRequest implements Serializable, Cloneable { /** * The name of the table from which to delete the item. *

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*/ private String tableName; /** * A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. */ private java.util.Map key; /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A map of attribute/condition pairs. * Expected provides a conditional block for the DeleteItem * operation.

Each element of Expected consists of an attribute * name, a comparison operator, and one or more values. DynamoDB compares * the attribute with the value(s) you supplied, using the comparison * operator. For each Expected element, the result of the * evaluation is either true or false.

If you specify more than one * element in the Expected map, then by default all of the * conditions must evaluate to true. In other words, the conditions are * ANDed together. (You can use the ConditionalOperator parameter * to OR the conditions instead. If you do this, then at least one of the * conditions must evaluate to true, rather than all of them.)

If the * Expected map evaluates to true, then the conditional operation * succeeds; otherwise, it fails.

Expected contains the * following:

  • AttributeValueList - One or more values * to evaluate against the supplied attribute. The number of values in * the list depends on the ComparisonOperator being used.

    For * type Number, value comparisons are numeric.

    String value * comparisons for greater than, equals, or less than are based on ASCII * character code values. For example, a is greater than * A, and a is greater than B. For * a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

    For type Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values.

  • *

    ComparisonOperator - A comparator for evaluating attributes * in the AttributeValueList. When performing the comparison, * DynamoDB uses strongly consistent reads.

    The following comparison * operators are available:

    EQ | NE | LE | LT | GE | GT | * NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | * BETWEEN

    The following are descriptions of each comparison * operator.

    • EQ : Equal. EQ is * supported for all datatypes, including lists and maps. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not equal {"NS":["6", "2", * "1"]}.

    • NE : Not equal. * NE is supported for all datatypes, including lists and * maps.

      AttributeValueList can contain only one * AttributeValue of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * AttributeValue of a different type than the one provided in the * request, the value does not match. For example, {"S":"6"} * does not equal {"N":"6"}. Also, {"N":"6"} * does not equal {"NS":["6", "2", "1"]}.

    • *

      LE : Less than or equal.

      AttributeValueList * can contain only one AttributeValue element of type String, * Number, or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • LT : Less than. *

      AttributeValueList can contain only one * AttributeValue of type String, Number, or Binary (not a set * type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GE : Greater than or equal. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, or Binary (not a * set type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GT : Greater than.

      AttributeValueList can * contain only one AttributeValue element of type String, Number, * or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • NOT_NULL : The attribute * exists. NOT_NULL is supported for all datatypes, * including lists and maps.

      This operator tests for the * existence of an attribute, not its data type. If the data type of * attribute "a" is null, and you evaluate it using * NOT_NULL, the result is a Boolean true. This * result is because the attribute "a" exists; its data type * is not relevant to the NOT_NULL comparison operator. *

    • NULL : The attribute does not * exist. NULL is supported for all datatypes, including * lists and maps.

      This operator tests for the nonexistence of * an attribute, not its data type. If the data type of attribute * "a" is null, and you evaluate it using NULL, * the result is a Boolean false. This is because the attribute * "a" exists; its data type is not relevant to the * NULL comparison operator.

    • *

      CONTAINS : Checks for a subsequence, or value in a * set.

      AttributeValueList can contain only one * AttributeValue 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 ("SS", * "NS", or "BS"), then the operator evaluates * to true if it finds an exact match with any member of the set. *

      CONTAINS is supported for lists: When evaluating "a CONTAINS * b", "a" can be a list; however, "b" * cannot be a set, a map, or a list.

    • *

      NOT_CONTAINS : Checks for absence of a subsequence, or * absence of a value in a set.

      AttributeValueList can contain * only one AttributeValue 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 * ("SS", "NS", or "BS"), then the * operator evaluates to true if it does not find an exact match * with any member of the set.

      NOT_CONTAINS is supported for lists: * When evaluating "a NOT CONTAINS b", "a" can * be a list; however, "b" cannot be a set, a map, or a * list.

    • BEGINS_WITH : Checks for a prefix. *

      AttributeValueList can contain only one * AttributeValue 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).

    • *

      IN : Checks for matching elements within two sets. *

      AttributeValueList can contain one or more * AttributeValue 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.

    • *
    • BETWEEN : Greater than or equal to the first * value, and less than or equal to the second value. *

      AttributeValueList must contain two AttributeValue * 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 AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not compare to * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}

For * usage examples of AttributeValueList and * ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer * Guide.

For backward compatibility with previous DynamoDB * releases, the following parameters can be used instead of * AttributeValueList and ComparisonOperator:

  • *

    Value - A value for DynamoDB to compare with an attribute. *

  • Exists - A Boolean value that causes DynamoDB to * evaluate the value before attempting the conditional operation:

      *
    • If Exists is true, DynamoDB will check to * see if that attribute value already exists in the table. If it is * found, then the condition evaluates to true; otherwise the condition * evaluate to false.

    • If Exists is * false, 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 condition evaluates to true. If * the value is found, despite the assumption that it does not exist, the * condition evaluates to false.

    Note that the default * value for Exists is true.

The * Value and Exists parameters are incompatible with * AttributeValueList and ComparisonOperator. Note that if * you use both sets of parameters at once, DynamoDB will return a * ValidationException exception.

This parameter does not * support attributes of type List or Map. */ private java.util.Map expected; /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. *

* Constraints:
* Allowed Values: AND, OR */ private String conditionalOperator; /** * Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:

  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

*

* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW */ private String returnValues; /** * A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE */ private String returnConsumedCapacity; /** * A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. *

* Constraints:
* Allowed Values: SIZE, NONE */ private String returnItemCollectionMetrics; /** * A condition that must be satisfied in order for a conditional * DeleteItem to succeed.

An expression can contain any of the * following:

  • Functions: attribute_exists | * attribute_not_exists | attribute_type | contains | begins_with | * size

    These function names are case-sensitive.

  • *

    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | * IN

  • Logical operators: AND | OR | * NOT

For more information on condition * expressions, see Specifying * Conditions in the Amazon DynamoDB Developer Guide. *

ConditionExpression replaces the legacy * ConditionalOperator and Expected parameters. */ private String conditionExpression; /** * One or more substitution tokens for attribute names in an expression. * The following are some use cases for using * ExpressionAttributeNames:

  • To access an attribute * whose name conflicts with a DynamoDB reserved word.

  • To * create a placeholder for repeating occurrences of an attribute name in * an expression.

  • To prevent special characters in an * attribute name from being misinterpreted in an expression.

*

Use the # character in an expression to dereference an * attribute name. For example, consider the following attribute name: *

  • Percentile

The name of this * attribute conflicts with a reserved word, so it cannot be used * directly in an expression. (For the complete list of reserved words, * see Reserved * Words in the Amazon DynamoDB Developer Guide). To work * around this, you could specify the following for * ExpressionAttributeNames: *

  • {"#P":"Percentile"}

You could * then use this substitution in an expression, as in this example: *

  • #P = :val

Tokens that begin * with the : character are expression attribute values, * which are placeholders for the actual value at runtime.

For * more information on expression attribute names, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. */ private java.util.Map expressionAttributeNames; /** * One or more values that can be substituted in an expression.

Use * the : (colon) character in an expression to dereference an * attribute value. For example, suppose that you wanted to check whether * the value of the ProductStatus attribute was one of the * following:

Available | Backordered | Discontinued *

You would first need to specify ExpressionAttributeValues as * follows:

{ ":avail":{"S":"Available"}, * ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

You could then use these values in an expression, such as this: *

ProductStatus IN (:avail, :back, :disc)

For more * information on expression attribute values, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. */ private java.util.Map expressionAttributeValues; /** * Default constructor for a new DeleteItemRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize this object after creating it. */ public DeleteItemRequest() {} /** * Constructs a new DeleteItemRequest object. * Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @param tableName The name of the table from which to delete the item. * @param key A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. */ public DeleteItemRequest(String tableName, java.util.Map key) { setTableName(tableName); setKey(key); } /** * Constructs a new DeleteItemRequest object. * Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @param tableName The name of the table from which to delete the item. * @param key A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. * @param returnValues Use ReturnValues if you want to get the * item attributes as they appeared before they were deleted. For * DeleteItem, the valid values are:

  • *

    NONE - If ReturnValues is not specified, or if * its value is NONE, then nothing is returned. (This * setting is the default for ReturnValues.)

  • *

    ALL_OLD - The content of the old item is returned. *

*/ public DeleteItemRequest(String tableName, java.util.Map key, String returnValues) { setTableName(tableName); setKey(key); setReturnValues(returnValues); } /** * Constructs a new DeleteItemRequest object. * Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @param tableName The name of the table from which to delete the item. * @param key A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. * @param returnValues Use ReturnValues if you want to get the * item attributes as they appeared before they were deleted. For * DeleteItem, the valid values are:

  • *

    NONE - If ReturnValues is not specified, or if * its value is NONE, then nothing is returned. (This * setting is the default for ReturnValues.)

  • *

    ALL_OLD - The content of the old item is returned. *

*/ public DeleteItemRequest(String tableName, java.util.Map key, ReturnValue returnValues) { this.tableName = tableName; this.key = key; this.returnValues = returnValues.toString(); } /** * The name of the table from which to delete the item. *

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @return The name of the table from which to delete the item. */ public String getTableName() { return tableName; } /** * The name of the table from which to delete the item. *

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @param tableName The name of the table from which to delete the item. */ public void setTableName(String tableName) { this.tableName = tableName; } /** * The name of the table from which to delete the item. *

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @param tableName The name of the table from which to delete the item. * * @return A reference to this updated object so that method calls can be chained * together. */ public DeleteItemRequest withTableName(String tableName) { this.tableName = tableName; return this; } /** * A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. * * @return A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. */ public java.util.Map getKey() { return key; } /** * A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. * * @param key A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. */ public void setKey(java.util.Map key) { this.key = key; } /** * A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. *

* Returns a reference to this object so that method calls can be chained together. * * @param key A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. * * @return A reference to this updated object so that method calls can be chained * together. */ public DeleteItemRequest withKey(java.util.Map key) { setKey(key); return this; } /** * A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. *

* This method accepts the hashKey, rangeKey of Key as * java.util.Map.Entry objects. * * @param hashKey Primary hash key. * @param rangeKey Primary range key. (null if it a hash-only table) */ public void setKey(java.util.Map.Entry hashKey, java.util.Map.Entry rangeKey) throws IllegalArgumentException { java.util.HashMap key = new java.util.HashMap(); if (hashKey != null) { key.put(hashKey.getKey(), hashKey.getValue()); } else throw new IllegalArgumentException("hashKey must be non-null object."); if (rangeKey != null) { key.put(rangeKey.getKey(), rangeKey.getValue()); } setKey(key); } /** * A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. *

* This method accepts the hashKey, rangeKey of Key as * java.util.Map.Entry objects. *

* Returns a reference to this object so that method calls can be chained together. * * @param hashKey Primary hash key. * @param rangeKey Primary range key. (null if it a hash-only table) */ public DeleteItemRequest withKey(java.util.Map.Entry hashKey, java.util.Map.Entry rangeKey) throws IllegalArgumentException { setKey(hashKey, rangeKey); return this; } /** * A map of attribute names to AttributeValue objects, * representing the primary key of the item to delete.

For the primary * key, you must provide all of the attributes. For example, with a hash * type primary key, you only need to provide the hash attribute. For a * hash-and-range type primary key, you must provide both the hash * attribute and the range attribute. *

* The method adds a new key-value pair into Key parameter, and returns a * reference to this object so that method calls can be chained together. * * @param key The key of the entry to be added into Key. * @param value The corresponding value of the entry to be added into Key. */ public DeleteItemRequest addKeyEntry(String key, AttributeValue value) { if (null == this.key) { this.key = new java.util.HashMap(); } if (this.key.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.key.put(key, value); return this; } /** * Removes all the entries added into Key. *

* Returns a reference to this object so that method calls can be chained together. */ public DeleteItemRequest clearKeyEntries() { this.key = null; return this; } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A map of attribute/condition pairs. * Expected provides a conditional block for the DeleteItem * operation.

Each element of Expected consists of an attribute * name, a comparison operator, and one or more values. DynamoDB compares * the attribute with the value(s) you supplied, using the comparison * operator. For each Expected element, the result of the * evaluation is either true or false.

If you specify more than one * element in the Expected map, then by default all of the * conditions must evaluate to true. In other words, the conditions are * ANDed together. (You can use the ConditionalOperator parameter * to OR the conditions instead. If you do this, then at least one of the * conditions must evaluate to true, rather than all of them.)

If the * Expected map evaluates to true, then the conditional operation * succeeds; otherwise, it fails.

Expected contains the * following:

  • AttributeValueList - One or more values * to evaluate against the supplied attribute. The number of values in * the list depends on the ComparisonOperator being used.

    For * type Number, value comparisons are numeric.

    String value * comparisons for greater than, equals, or less than are based on ASCII * character code values. For example, a is greater than * A, and a is greater than B. For * a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

    For type Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values.

  • *

    ComparisonOperator - A comparator for evaluating attributes * in the AttributeValueList. When performing the comparison, * DynamoDB uses strongly consistent reads.

    The following comparison * operators are available:

    EQ | NE | LE | LT | GE | GT | * NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | * BETWEEN

    The following are descriptions of each comparison * operator.

    • EQ : Equal. EQ is * supported for all datatypes, including lists and maps. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not equal {"NS":["6", "2", * "1"]}.

    • NE : Not equal. * NE is supported for all datatypes, including lists and * maps.

      AttributeValueList can contain only one * AttributeValue of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * AttributeValue of a different type than the one provided in the * request, the value does not match. For example, {"S":"6"} * does not equal {"N":"6"}. Also, {"N":"6"} * does not equal {"NS":["6", "2", "1"]}.

    • *

      LE : Less than or equal.

      AttributeValueList * can contain only one AttributeValue element of type String, * Number, or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • LT : Less than. *

      AttributeValueList can contain only one * AttributeValue of type String, Number, or Binary (not a set * type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GE : Greater than or equal. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, or Binary (not a * set type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GT : Greater than.

      AttributeValueList can * contain only one AttributeValue element of type String, Number, * or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • NOT_NULL : The attribute * exists. NOT_NULL is supported for all datatypes, * including lists and maps.

      This operator tests for the * existence of an attribute, not its data type. If the data type of * attribute "a" is null, and you evaluate it using * NOT_NULL, the result is a Boolean true. This * result is because the attribute "a" exists; its data type * is not relevant to the NOT_NULL comparison operator. *

    • NULL : The attribute does not * exist. NULL is supported for all datatypes, including * lists and maps.

      This operator tests for the nonexistence of * an attribute, not its data type. If the data type of attribute * "a" is null, and you evaluate it using NULL, * the result is a Boolean false. This is because the attribute * "a" exists; its data type is not relevant to the * NULL comparison operator.

    • *

      CONTAINS : Checks for a subsequence, or value in a * set.

      AttributeValueList can contain only one * AttributeValue 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 ("SS", * "NS", or "BS"), then the operator evaluates * to true if it finds an exact match with any member of the set. *

      CONTAINS is supported for lists: When evaluating "a CONTAINS * b", "a" can be a list; however, "b" * cannot be a set, a map, or a list.

    • *

      NOT_CONTAINS : Checks for absence of a subsequence, or * absence of a value in a set.

      AttributeValueList can contain * only one AttributeValue 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 * ("SS", "NS", or "BS"), then the * operator evaluates to true if it does not find an exact match * with any member of the set.

      NOT_CONTAINS is supported for lists: * When evaluating "a NOT CONTAINS b", "a" can * be a list; however, "b" cannot be a set, a map, or a * list.

    • BEGINS_WITH : Checks for a prefix. *

      AttributeValueList can contain only one * AttributeValue 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).

    • *

      IN : Checks for matching elements within two sets. *

      AttributeValueList can contain one or more * AttributeValue 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.

    • *
    • BETWEEN : Greater than or equal to the first * value, and less than or equal to the second value. *

      AttributeValueList must contain two AttributeValue * 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 AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not compare to * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}

For * usage examples of AttributeValueList and * ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer * Guide.

For backward compatibility with previous DynamoDB * releases, the following parameters can be used instead of * AttributeValueList and ComparisonOperator:

  • *

    Value - A value for DynamoDB to compare with an attribute. *

  • Exists - A Boolean value that causes DynamoDB to * evaluate the value before attempting the conditional operation:

      *
    • If Exists is true, DynamoDB will check to * see if that attribute value already exists in the table. If it is * found, then the condition evaluates to true; otherwise the condition * evaluate to false.

    • If Exists is * false, 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 condition evaluates to true. If * the value is found, despite the assumption that it does not exist, the * condition evaluates to false.

    Note that the default * value for Exists is true.

The * Value and Exists parameters are incompatible with * AttributeValueList and ComparisonOperator. Note that if * you use both sets of parameters at once, DynamoDB will return a * ValidationException exception.

This parameter does not * support attributes of type List or Map. * * @return

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A map of attribute/condition pairs. * Expected provides a conditional block for the DeleteItem * operation.

Each element of Expected consists of an attribute * name, a comparison operator, and one or more values. DynamoDB compares * the attribute with the value(s) you supplied, using the comparison * operator. For each Expected element, the result of the * evaluation is either true or false.

If you specify more than one * element in the Expected map, then by default all of the * conditions must evaluate to true. In other words, the conditions are * ANDed together. (You can use the ConditionalOperator parameter * to OR the conditions instead. If you do this, then at least one of the * conditions must evaluate to true, rather than all of them.)

If the * Expected map evaluates to true, then the conditional operation * succeeds; otherwise, it fails.

Expected contains the * following:

  • AttributeValueList - One or more values * to evaluate against the supplied attribute. The number of values in * the list depends on the ComparisonOperator being used.

    For * type Number, value comparisons are numeric.

    String value * comparisons for greater than, equals, or less than are based on ASCII * character code values. For example, a is greater than * A, and a is greater than B. For * a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

    For type Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values.

  • *

    ComparisonOperator - A comparator for evaluating attributes * in the AttributeValueList. When performing the comparison, * DynamoDB uses strongly consistent reads.

    The following comparison * operators are available:

    EQ | NE | LE | LT | GE | GT | * NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | * BETWEEN

    The following are descriptions of each comparison * operator.

    • EQ : Equal. EQ is * supported for all datatypes, including lists and maps. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not equal {"NS":["6", "2", * "1"]}.

    • NE : Not equal. * NE is supported for all datatypes, including lists and * maps.

      AttributeValueList can contain only one * AttributeValue of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * AttributeValue of a different type than the one provided in the * request, the value does not match. For example, {"S":"6"} * does not equal {"N":"6"}. Also, {"N":"6"} * does not equal {"NS":["6", "2", "1"]}.

    • *

      LE : Less than or equal.

      AttributeValueList * can contain only one AttributeValue element of type String, * Number, or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • LT : Less than. *

      AttributeValueList can contain only one * AttributeValue of type String, Number, or Binary (not a set * type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GE : Greater than or equal. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, or Binary (not a * set type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GT : Greater than.

      AttributeValueList can * contain only one AttributeValue element of type String, Number, * or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • NOT_NULL : The attribute * exists. NOT_NULL is supported for all datatypes, * including lists and maps.

      This operator tests for the * existence of an attribute, not its data type. If the data type of * attribute "a" is null, and you evaluate it using * NOT_NULL, the result is a Boolean true. This * result is because the attribute "a" exists; its data type * is not relevant to the NOT_NULL comparison operator. *

    • NULL : The attribute does not * exist. NULL is supported for all datatypes, including * lists and maps.

      This operator tests for the nonexistence of * an attribute, not its data type. If the data type of attribute * "a" is null, and you evaluate it using NULL, * the result is a Boolean false. This is because the attribute * "a" exists; its data type is not relevant to the * NULL comparison operator.

    • *

      CONTAINS : Checks for a subsequence, or value in a * set.

      AttributeValueList can contain only one * AttributeValue 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 ("SS", * "NS", or "BS"), then the operator evaluates * to true if it finds an exact match with any member of the set. *

      CONTAINS is supported for lists: When evaluating "a CONTAINS * b", "a" can be a list; however, "b" * cannot be a set, a map, or a list.

    • *

      NOT_CONTAINS : Checks for absence of a subsequence, or * absence of a value in a set.

      AttributeValueList can contain * only one AttributeValue 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 * ("SS", "NS", or "BS"), then the * operator evaluates to true if it does not find an exact match * with any member of the set.

      NOT_CONTAINS is supported for lists: * When evaluating "a NOT CONTAINS b", "a" can * be a list; however, "b" cannot be a set, a map, or a * list.

    • BEGINS_WITH : Checks for a prefix. *

      AttributeValueList can contain only one * AttributeValue 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).

    • *

      IN : Checks for matching elements within two sets. *

      AttributeValueList can contain one or more * AttributeValue 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.

    • *
    • BETWEEN : Greater than or equal to the first * value, and less than or equal to the second value. *

      AttributeValueList must contain two AttributeValue * 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 AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not compare to * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}

For * usage examples of AttributeValueList and * ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer * Guide.

For backward compatibility with previous DynamoDB * releases, the following parameters can be used instead of * AttributeValueList and ComparisonOperator:

  • *

    Value - A value for DynamoDB to compare with an attribute. *

  • Exists - A Boolean value that causes DynamoDB to * evaluate the value before attempting the conditional operation:

      *
    • If Exists is true, DynamoDB will check to * see if that attribute value already exists in the table. If it is * found, then the condition evaluates to true; otherwise the condition * evaluate to false.

    • If Exists is * false, 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 condition evaluates to true. If * the value is found, despite the assumption that it does not exist, the * condition evaluates to false.

    Note that the default * value for Exists is true.

The * Value and Exists parameters are incompatible with * AttributeValueList and ComparisonOperator. Note that if * you use both sets of parameters at once, DynamoDB will return a * ValidationException exception.

This parameter does not * support attributes of type List or Map. */ public java.util.Map getExpected() { return expected; } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A map of attribute/condition pairs. * Expected provides a conditional block for the DeleteItem * operation.

Each element of Expected consists of an attribute * name, a comparison operator, and one or more values. DynamoDB compares * the attribute with the value(s) you supplied, using the comparison * operator. For each Expected element, the result of the * evaluation is either true or false.

If you specify more than one * element in the Expected map, then by default all of the * conditions must evaluate to true. In other words, the conditions are * ANDed together. (You can use the ConditionalOperator parameter * to OR the conditions instead. If you do this, then at least one of the * conditions must evaluate to true, rather than all of them.)

If the * Expected map evaluates to true, then the conditional operation * succeeds; otherwise, it fails.

Expected contains the * following:

  • AttributeValueList - One or more values * to evaluate against the supplied attribute. The number of values in * the list depends on the ComparisonOperator being used.

    For * type Number, value comparisons are numeric.

    String value * comparisons for greater than, equals, or less than are based on ASCII * character code values. For example, a is greater than * A, and a is greater than B. For * a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

    For type Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values.

  • *

    ComparisonOperator - A comparator for evaluating attributes * in the AttributeValueList. When performing the comparison, * DynamoDB uses strongly consistent reads.

    The following comparison * operators are available:

    EQ | NE | LE | LT | GE | GT | * NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | * BETWEEN

    The following are descriptions of each comparison * operator.

    • EQ : Equal. EQ is * supported for all datatypes, including lists and maps. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not equal {"NS":["6", "2", * "1"]}.

    • NE : Not equal. * NE is supported for all datatypes, including lists and * maps.

      AttributeValueList can contain only one * AttributeValue of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * AttributeValue of a different type than the one provided in the * request, the value does not match. For example, {"S":"6"} * does not equal {"N":"6"}. Also, {"N":"6"} * does not equal {"NS":["6", "2", "1"]}.

    • *

      LE : Less than or equal.

      AttributeValueList * can contain only one AttributeValue element of type String, * Number, or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • LT : Less than. *

      AttributeValueList can contain only one * AttributeValue of type String, Number, or Binary (not a set * type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GE : Greater than or equal. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, or Binary (not a * set type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GT : Greater than.

      AttributeValueList can * contain only one AttributeValue element of type String, Number, * or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • NOT_NULL : The attribute * exists. NOT_NULL is supported for all datatypes, * including lists and maps.

      This operator tests for the * existence of an attribute, not its data type. If the data type of * attribute "a" is null, and you evaluate it using * NOT_NULL, the result is a Boolean true. This * result is because the attribute "a" exists; its data type * is not relevant to the NOT_NULL comparison operator. *

    • NULL : The attribute does not * exist. NULL is supported for all datatypes, including * lists and maps.

      This operator tests for the nonexistence of * an attribute, not its data type. If the data type of attribute * "a" is null, and you evaluate it using NULL, * the result is a Boolean false. This is because the attribute * "a" exists; its data type is not relevant to the * NULL comparison operator.

    • *

      CONTAINS : Checks for a subsequence, or value in a * set.

      AttributeValueList can contain only one * AttributeValue 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 ("SS", * "NS", or "BS"), then the operator evaluates * to true if it finds an exact match with any member of the set. *

      CONTAINS is supported for lists: When evaluating "a CONTAINS * b", "a" can be a list; however, "b" * cannot be a set, a map, or a list.

    • *

      NOT_CONTAINS : Checks for absence of a subsequence, or * absence of a value in a set.

      AttributeValueList can contain * only one AttributeValue 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 * ("SS", "NS", or "BS"), then the * operator evaluates to true if it does not find an exact match * with any member of the set.

      NOT_CONTAINS is supported for lists: * When evaluating "a NOT CONTAINS b", "a" can * be a list; however, "b" cannot be a set, a map, or a * list.

    • BEGINS_WITH : Checks for a prefix. *

      AttributeValueList can contain only one * AttributeValue 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).

    • *

      IN : Checks for matching elements within two sets. *

      AttributeValueList can contain one or more * AttributeValue 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.

    • *
    • BETWEEN : Greater than or equal to the first * value, and less than or equal to the second value. *

      AttributeValueList must contain two AttributeValue * 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 AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not compare to * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}

For * usage examples of AttributeValueList and * ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer * Guide.

For backward compatibility with previous DynamoDB * releases, the following parameters can be used instead of * AttributeValueList and ComparisonOperator:

  • *

    Value - A value for DynamoDB to compare with an attribute. *

  • Exists - A Boolean value that causes DynamoDB to * evaluate the value before attempting the conditional operation:

      *
    • If Exists is true, DynamoDB will check to * see if that attribute value already exists in the table. If it is * found, then the condition evaluates to true; otherwise the condition * evaluate to false.

    • If Exists is * false, 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 condition evaluates to true. If * the value is found, despite the assumption that it does not exist, the * condition evaluates to false.

    Note that the default * value for Exists is true.

The * Value and Exists parameters are incompatible with * AttributeValueList and ComparisonOperator. Note that if * you use both sets of parameters at once, DynamoDB will return a * ValidationException exception.

This parameter does not * support attributes of type List or Map. * * @param expected

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A map of attribute/condition pairs. * Expected provides a conditional block for the DeleteItem * operation.

Each element of Expected consists of an attribute * name, a comparison operator, and one or more values. DynamoDB compares * the attribute with the value(s) you supplied, using the comparison * operator. For each Expected element, the result of the * evaluation is either true or false.

If you specify more than one * element in the Expected map, then by default all of the * conditions must evaluate to true. In other words, the conditions are * ANDed together. (You can use the ConditionalOperator parameter * to OR the conditions instead. If you do this, then at least one of the * conditions must evaluate to true, rather than all of them.)

If the * Expected map evaluates to true, then the conditional operation * succeeds; otherwise, it fails.

Expected contains the * following:

  • AttributeValueList - One or more values * to evaluate against the supplied attribute. The number of values in * the list depends on the ComparisonOperator being used.

    For * type Number, value comparisons are numeric.

    String value * comparisons for greater than, equals, or less than are based on ASCII * character code values. For example, a is greater than * A, and a is greater than B. For * a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

    For type Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values.

  • *

    ComparisonOperator - A comparator for evaluating attributes * in the AttributeValueList. When performing the comparison, * DynamoDB uses strongly consistent reads.

    The following comparison * operators are available:

    EQ | NE | LE | LT | GE | GT | * NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | * BETWEEN

    The following are descriptions of each comparison * operator.

    • EQ : Equal. EQ is * supported for all datatypes, including lists and maps. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not equal {"NS":["6", "2", * "1"]}.

    • NE : Not equal. * NE is supported for all datatypes, including lists and * maps.

      AttributeValueList can contain only one * AttributeValue of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * AttributeValue of a different type than the one provided in the * request, the value does not match. For example, {"S":"6"} * does not equal {"N":"6"}. Also, {"N":"6"} * does not equal {"NS":["6", "2", "1"]}.

    • *

      LE : Less than or equal.

      AttributeValueList * can contain only one AttributeValue element of type String, * Number, or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • LT : Less than. *

      AttributeValueList can contain only one * AttributeValue of type String, Number, or Binary (not a set * type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GE : Greater than or equal. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, or Binary (not a * set type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GT : Greater than.

      AttributeValueList can * contain only one AttributeValue element of type String, Number, * or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • NOT_NULL : The attribute * exists. NOT_NULL is supported for all datatypes, * including lists and maps.

      This operator tests for the * existence of an attribute, not its data type. If the data type of * attribute "a" is null, and you evaluate it using * NOT_NULL, the result is a Boolean true. This * result is because the attribute "a" exists; its data type * is not relevant to the NOT_NULL comparison operator. *

    • NULL : The attribute does not * exist. NULL is supported for all datatypes, including * lists and maps.

      This operator tests for the nonexistence of * an attribute, not its data type. If the data type of attribute * "a" is null, and you evaluate it using NULL, * the result is a Boolean false. This is because the attribute * "a" exists; its data type is not relevant to the * NULL comparison operator.

    • *

      CONTAINS : Checks for a subsequence, or value in a * set.

      AttributeValueList can contain only one * AttributeValue 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 ("SS", * "NS", or "BS"), then the operator evaluates * to true if it finds an exact match with any member of the set. *

      CONTAINS is supported for lists: When evaluating "a CONTAINS * b", "a" can be a list; however, "b" * cannot be a set, a map, or a list.

    • *

      NOT_CONTAINS : Checks for absence of a subsequence, or * absence of a value in a set.

      AttributeValueList can contain * only one AttributeValue 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 * ("SS", "NS", or "BS"), then the * operator evaluates to true if it does not find an exact match * with any member of the set.

      NOT_CONTAINS is supported for lists: * When evaluating "a NOT CONTAINS b", "a" can * be a list; however, "b" cannot be a set, a map, or a * list.

    • BEGINS_WITH : Checks for a prefix. *

      AttributeValueList can contain only one * AttributeValue 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).

    • *

      IN : Checks for matching elements within two sets. *

      AttributeValueList can contain one or more * AttributeValue 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.

    • *
    • BETWEEN : Greater than or equal to the first * value, and less than or equal to the second value. *

      AttributeValueList must contain two AttributeValue * 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 AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not compare to * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}

For * usage examples of AttributeValueList and * ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer * Guide.

For backward compatibility with previous DynamoDB * releases, the following parameters can be used instead of * AttributeValueList and ComparisonOperator:

  • *

    Value - A value for DynamoDB to compare with an attribute. *

  • Exists - A Boolean value that causes DynamoDB to * evaluate the value before attempting the conditional operation:

      *
    • If Exists is true, DynamoDB will check to * see if that attribute value already exists in the table. If it is * found, then the condition evaluates to true; otherwise the condition * evaluate to false.

    • If Exists is * false, 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 condition evaluates to true. If * the value is found, despite the assumption that it does not exist, the * condition evaluates to false.

    Note that the default * value for Exists is true.

The * Value and Exists parameters are incompatible with * AttributeValueList and ComparisonOperator. Note that if * you use both sets of parameters at once, DynamoDB will return a * ValidationException exception.

This parameter does not * support attributes of type List or Map. */ public void setExpected(java.util.Map expected) { this.expected = expected; } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A map of attribute/condition pairs. * Expected provides a conditional block for the DeleteItem * operation.

Each element of Expected consists of an attribute * name, a comparison operator, and one or more values. DynamoDB compares * the attribute with the value(s) you supplied, using the comparison * operator. For each Expected element, the result of the * evaluation is either true or false.

If you specify more than one * element in the Expected map, then by default all of the * conditions must evaluate to true. In other words, the conditions are * ANDed together. (You can use the ConditionalOperator parameter * to OR the conditions instead. If you do this, then at least one of the * conditions must evaluate to true, rather than all of them.)

If the * Expected map evaluates to true, then the conditional operation * succeeds; otherwise, it fails.

Expected contains the * following:

  • AttributeValueList - One or more values * to evaluate against the supplied attribute. The number of values in * the list depends on the ComparisonOperator being used.

    For * type Number, value comparisons are numeric.

    String value * comparisons for greater than, equals, or less than are based on ASCII * character code values. For example, a is greater than * A, and a is greater than B. For * a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

    For type Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values.

  • *

    ComparisonOperator - A comparator for evaluating attributes * in the AttributeValueList. When performing the comparison, * DynamoDB uses strongly consistent reads.

    The following comparison * operators are available:

    EQ | NE | LE | LT | GE | GT | * NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | * BETWEEN

    The following are descriptions of each comparison * operator.

    • EQ : Equal. EQ is * supported for all datatypes, including lists and maps. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not equal {"NS":["6", "2", * "1"]}.

    • NE : Not equal. * NE is supported for all datatypes, including lists and * maps.

      AttributeValueList can contain only one * AttributeValue of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * AttributeValue of a different type than the one provided in the * request, the value does not match. For example, {"S":"6"} * does not equal {"N":"6"}. Also, {"N":"6"} * does not equal {"NS":["6", "2", "1"]}.

    • *

      LE : Less than or equal.

      AttributeValueList * can contain only one AttributeValue element of type String, * Number, or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • LT : Less than. *

      AttributeValueList can contain only one * AttributeValue of type String, Number, or Binary (not a set * type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GE : Greater than or equal. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, or Binary (not a * set type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GT : Greater than.

      AttributeValueList can * contain only one AttributeValue element of type String, Number, * or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • NOT_NULL : The attribute * exists. NOT_NULL is supported for all datatypes, * including lists and maps.

      This operator tests for the * existence of an attribute, not its data type. If the data type of * attribute "a" is null, and you evaluate it using * NOT_NULL, the result is a Boolean true. This * result is because the attribute "a" exists; its data type * is not relevant to the NOT_NULL comparison operator. *

    • NULL : The attribute does not * exist. NULL is supported for all datatypes, including * lists and maps.

      This operator tests for the nonexistence of * an attribute, not its data type. If the data type of attribute * "a" is null, and you evaluate it using NULL, * the result is a Boolean false. This is because the attribute * "a" exists; its data type is not relevant to the * NULL comparison operator.

    • *

      CONTAINS : Checks for a subsequence, or value in a * set.

      AttributeValueList can contain only one * AttributeValue 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 ("SS", * "NS", or "BS"), then the operator evaluates * to true if it finds an exact match with any member of the set. *

      CONTAINS is supported for lists: When evaluating "a CONTAINS * b", "a" can be a list; however, "b" * cannot be a set, a map, or a list.

    • *

      NOT_CONTAINS : Checks for absence of a subsequence, or * absence of a value in a set.

      AttributeValueList can contain * only one AttributeValue 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 * ("SS", "NS", or "BS"), then the * operator evaluates to true if it does not find an exact match * with any member of the set.

      NOT_CONTAINS is supported for lists: * When evaluating "a NOT CONTAINS b", "a" can * be a list; however, "b" cannot be a set, a map, or a * list.

    • BEGINS_WITH : Checks for a prefix. *

      AttributeValueList can contain only one * AttributeValue 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).

    • *

      IN : Checks for matching elements within two sets. *

      AttributeValueList can contain one or more * AttributeValue 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.

    • *
    • BETWEEN : Greater than or equal to the first * value, and less than or equal to the second value. *

      AttributeValueList must contain two AttributeValue * 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 AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not compare to * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}

For * usage examples of AttributeValueList and * ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer * Guide.

For backward compatibility with previous DynamoDB * releases, the following parameters can be used instead of * AttributeValueList and ComparisonOperator:

  • *

    Value - A value for DynamoDB to compare with an attribute. *

  • Exists - A Boolean value that causes DynamoDB to * evaluate the value before attempting the conditional operation:

      *
    • If Exists is true, DynamoDB will check to * see if that attribute value already exists in the table. If it is * found, then the condition evaluates to true; otherwise the condition * evaluate to false.

    • If Exists is * false, 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 condition evaluates to true. If * the value is found, despite the assumption that it does not exist, the * condition evaluates to false.

    Note that the default * value for Exists is true.

The * Value and Exists parameters are incompatible with * AttributeValueList and ComparisonOperator. Note that if * you use both sets of parameters at once, DynamoDB will return a * ValidationException exception.

This parameter does not * support attributes of type List or Map. *

* Returns a reference to this object so that method calls can be chained together. * * @param expected

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A map of attribute/condition pairs. * Expected provides a conditional block for the DeleteItem * operation.

Each element of Expected consists of an attribute * name, a comparison operator, and one or more values. DynamoDB compares * the attribute with the value(s) you supplied, using the comparison * operator. For each Expected element, the result of the * evaluation is either true or false.

If you specify more than one * element in the Expected map, then by default all of the * conditions must evaluate to true. In other words, the conditions are * ANDed together. (You can use the ConditionalOperator parameter * to OR the conditions instead. If you do this, then at least one of the * conditions must evaluate to true, rather than all of them.)

If the * Expected map evaluates to true, then the conditional operation * succeeds; otherwise, it fails.

Expected contains the * following:

  • AttributeValueList - One or more values * to evaluate against the supplied attribute. The number of values in * the list depends on the ComparisonOperator being used.

    For * type Number, value comparisons are numeric.

    String value * comparisons for greater than, equals, or less than are based on ASCII * character code values. For example, a is greater than * A, and a is greater than B. For * a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

    For type Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values.

  • *

    ComparisonOperator - A comparator for evaluating attributes * in the AttributeValueList. When performing the comparison, * DynamoDB uses strongly consistent reads.

    The following comparison * operators are available:

    EQ | NE | LE | LT | GE | GT | * NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | * BETWEEN

    The following are descriptions of each comparison * operator.

    • EQ : Equal. EQ is * supported for all datatypes, including lists and maps. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not equal {"NS":["6", "2", * "1"]}.

    • NE : Not equal. * NE is supported for all datatypes, including lists and * maps.

      AttributeValueList can contain only one * AttributeValue of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * AttributeValue of a different type than the one provided in the * request, the value does not match. For example, {"S":"6"} * does not equal {"N":"6"}. Also, {"N":"6"} * does not equal {"NS":["6", "2", "1"]}.

    • *

      LE : Less than or equal.

      AttributeValueList * can contain only one AttributeValue element of type String, * Number, or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • LT : Less than. *

      AttributeValueList can contain only one * AttributeValue of type String, Number, or Binary (not a set * type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GE : Greater than or equal. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, or Binary (not a * set type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GT : Greater than.

      AttributeValueList can * contain only one AttributeValue element of type String, Number, * or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • NOT_NULL : The attribute * exists. NOT_NULL is supported for all datatypes, * including lists and maps.

      This operator tests for the * existence of an attribute, not its data type. If the data type of * attribute "a" is null, and you evaluate it using * NOT_NULL, the result is a Boolean true. This * result is because the attribute "a" exists; its data type * is not relevant to the NOT_NULL comparison operator. *

    • NULL : The attribute does not * exist. NULL is supported for all datatypes, including * lists and maps.

      This operator tests for the nonexistence of * an attribute, not its data type. If the data type of attribute * "a" is null, and you evaluate it using NULL, * the result is a Boolean false. This is because the attribute * "a" exists; its data type is not relevant to the * NULL comparison operator.

    • *

      CONTAINS : Checks for a subsequence, or value in a * set.

      AttributeValueList can contain only one * AttributeValue 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 ("SS", * "NS", or "BS"), then the operator evaluates * to true if it finds an exact match with any member of the set. *

      CONTAINS is supported for lists: When evaluating "a CONTAINS * b", "a" can be a list; however, "b" * cannot be a set, a map, or a list.

    • *

      NOT_CONTAINS : Checks for absence of a subsequence, or * absence of a value in a set.

      AttributeValueList can contain * only one AttributeValue 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 * ("SS", "NS", or "BS"), then the * operator evaluates to true if it does not find an exact match * with any member of the set.

      NOT_CONTAINS is supported for lists: * When evaluating "a NOT CONTAINS b", "a" can * be a list; however, "b" cannot be a set, a map, or a * list.

    • BEGINS_WITH : Checks for a prefix. *

      AttributeValueList can contain only one * AttributeValue 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).

    • *

      IN : Checks for matching elements within two sets. *

      AttributeValueList can contain one or more * AttributeValue 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.

    • *
    • BETWEEN : Greater than or equal to the first * value, and less than or equal to the second value. *

      AttributeValueList must contain two AttributeValue * 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 AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not compare to * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}

For * usage examples of AttributeValueList and * ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer * Guide.

For backward compatibility with previous DynamoDB * releases, the following parameters can be used instead of * AttributeValueList and ComparisonOperator:

  • *

    Value - A value for DynamoDB to compare with an attribute. *

  • Exists - A Boolean value that causes DynamoDB to * evaluate the value before attempting the conditional operation:

      *
    • If Exists is true, DynamoDB will check to * see if that attribute value already exists in the table. If it is * found, then the condition evaluates to true; otherwise the condition * evaluate to false.

    • If Exists is * false, 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 condition evaluates to true. If * the value is found, despite the assumption that it does not exist, the * condition evaluates to false.

    Note that the default * value for Exists is true.

The * Value and Exists parameters are incompatible with * AttributeValueList and ComparisonOperator. Note that if * you use both sets of parameters at once, DynamoDB will return a * ValidationException exception.

This parameter does not * support attributes of type List or Map. * * @return A reference to this updated object so that method calls can be chained * together. */ public DeleteItemRequest withExpected(java.util.Map expected) { setExpected(expected); return this; } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A map of attribute/condition pairs. * Expected provides a conditional block for the DeleteItem * operation.

Each element of Expected consists of an attribute * name, a comparison operator, and one or more values. DynamoDB compares * the attribute with the value(s) you supplied, using the comparison * operator. For each Expected element, the result of the * evaluation is either true or false.

If you specify more than one * element in the Expected map, then by default all of the * conditions must evaluate to true. In other words, the conditions are * ANDed together. (You can use the ConditionalOperator parameter * to OR the conditions instead. If you do this, then at least one of the * conditions must evaluate to true, rather than all of them.)

If the * Expected map evaluates to true, then the conditional operation * succeeds; otherwise, it fails.

Expected contains the * following:

  • AttributeValueList - One or more values * to evaluate against the supplied attribute. The number of values in * the list depends on the ComparisonOperator being used.

    For * type Number, value comparisons are numeric.

    String value * comparisons for greater than, equals, or less than are based on ASCII * character code values. For example, a is greater than * A, and a is greater than B. For * a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

    For type Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values.

  • *

    ComparisonOperator - A comparator for evaluating attributes * in the AttributeValueList. When performing the comparison, * DynamoDB uses strongly consistent reads.

    The following comparison * operators are available:

    EQ | NE | LE | LT | GE | GT | * NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | * BETWEEN

    The following are descriptions of each comparison * operator.

    • EQ : Equal. EQ is * supported for all datatypes, including lists and maps. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, Binary, String * Set, Number Set, or Binary Set. If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not equal {"NS":["6", "2", * "1"]}.

    • NE : Not equal. * NE is supported for all datatypes, including lists and * maps.

      AttributeValueList can contain only one * AttributeValue of type String, Number, Binary, String Set, * Number Set, or Binary Set. If an item contains an * AttributeValue of a different type than the one provided in the * request, the value does not match. For example, {"S":"6"} * does not equal {"N":"6"}. Also, {"N":"6"} * does not equal {"NS":["6", "2", "1"]}.

    • *

      LE : Less than or equal.

      AttributeValueList * can contain only one AttributeValue element of type String, * Number, or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • LT : Less than. *

      AttributeValueList can contain only one * AttributeValue of type String, Number, or Binary (not a set * type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GE : Greater than or equal. *

      AttributeValueList can contain only one * AttributeValue element of type String, Number, or Binary (not a * set type). If an item contains an AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not equal * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}.

    • *

      GT : Greater than.

      AttributeValueList can * contain only one AttributeValue element of type String, Number, * or Binary (not a set type). If an item contains an * AttributeValue element of a different type than the one * provided in the request, the value does not match. For example, * {"S":"6"} does not equal {"N":"6"}. Also, * {"N":"6"} does not compare to {"NS":["6", "2", * "1"]}.

    • NOT_NULL : The attribute * exists. NOT_NULL is supported for all datatypes, * including lists and maps.

      This operator tests for the * existence of an attribute, not its data type. If the data type of * attribute "a" is null, and you evaluate it using * NOT_NULL, the result is a Boolean true. This * result is because the attribute "a" exists; its data type * is not relevant to the NOT_NULL comparison operator. *

    • NULL : The attribute does not * exist. NULL is supported for all datatypes, including * lists and maps.

      This operator tests for the nonexistence of * an attribute, not its data type. If the data type of attribute * "a" is null, and you evaluate it using NULL, * the result is a Boolean false. This is because the attribute * "a" exists; its data type is not relevant to the * NULL comparison operator.

    • *

      CONTAINS : Checks for a subsequence, or value in a * set.

      AttributeValueList can contain only one * AttributeValue 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 ("SS", * "NS", or "BS"), then the operator evaluates * to true if it finds an exact match with any member of the set. *

      CONTAINS is supported for lists: When evaluating "a CONTAINS * b", "a" can be a list; however, "b" * cannot be a set, a map, or a list.

    • *

      NOT_CONTAINS : Checks for absence of a subsequence, or * absence of a value in a set.

      AttributeValueList can contain * only one AttributeValue 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 * ("SS", "NS", or "BS"), then the * operator evaluates to true if it does not find an exact match * with any member of the set.

      NOT_CONTAINS is supported for lists: * When evaluating "a NOT CONTAINS b", "a" can * be a list; however, "b" cannot be a set, a map, or a * list.

    • BEGINS_WITH : Checks for a prefix. *

      AttributeValueList can contain only one * AttributeValue 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).

    • *

      IN : Checks for matching elements within two sets. *

      AttributeValueList can contain one or more * AttributeValue 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.

    • *
    • BETWEEN : Greater than or equal to the first * value, and less than or equal to the second value. *

      AttributeValueList must contain two AttributeValue * 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 AttributeValue element of a * different type than the one provided in the request, the value does * not match. For example, {"S":"6"} does not compare to * {"N":"6"}. Also, {"N":"6"} does not compare * to {"NS":["6", "2", "1"]}

For * usage examples of AttributeValueList and * ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer * Guide.

For backward compatibility with previous DynamoDB * releases, the following parameters can be used instead of * AttributeValueList and ComparisonOperator:

  • *

    Value - A value for DynamoDB to compare with an attribute. *

  • Exists - A Boolean value that causes DynamoDB to * evaluate the value before attempting the conditional operation:

      *
    • If Exists is true, DynamoDB will check to * see if that attribute value already exists in the table. If it is * found, then the condition evaluates to true; otherwise the condition * evaluate to false.

    • If Exists is * false, 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 condition evaluates to true. If * the value is found, despite the assumption that it does not exist, the * condition evaluates to false.

    Note that the default * value for Exists is true.

The * Value and Exists parameters are incompatible with * AttributeValueList and ComparisonOperator. Note that if * you use both sets of parameters at once, DynamoDB will return a * ValidationException exception.

This parameter does not * support attributes of type List or Map. *

* The method adds a new key-value pair into Expected parameter, and * returns a reference to this object so that method calls can be chained * together. * * @param key The key of the entry to be added into Expected. * @param value The corresponding value of the entry to be added into Expected. */ public DeleteItemRequest addExpectedEntry(String key, ExpectedAttributeValue value) { if (null == this.expected) { this.expected = new java.util.HashMap(); } if (this.expected.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expected.put(key, value); return this; } /** * Removes all the entries added into Expected. *

* Returns a reference to this object so that method calls can be chained together. */ public DeleteItemRequest clearExpectedEntries() { this.expected = null; return this; } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. *

* Constraints:
* Allowed Values: AND, OR * * @return

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. * * @see ConditionalOperator */ public String getConditionalOperator() { return conditionalOperator; } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. *

* Constraints:
* Allowed Values: AND, OR * * @param conditionalOperator

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. * * @see ConditionalOperator */ public void setConditionalOperator(String conditionalOperator) { this.conditionalOperator = conditionalOperator; } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. *

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Allowed Values: AND, OR * * @param conditionalOperator

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. * * @return A reference to this updated object so that method calls can be chained * together. * * @see ConditionalOperator */ public DeleteItemRequest withConditionalOperator(String conditionalOperator) { this.conditionalOperator = conditionalOperator; return this; } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. *

* Constraints:
* Allowed Values: AND, OR * * @param conditionalOperator

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. * * @see ConditionalOperator */ public void setConditionalOperator(ConditionalOperator conditionalOperator) { this.conditionalOperator = conditionalOperator.toString(); } /** *

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. *

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Allowed Values: AND, OR * * @param conditionalOperator

This is a legacy parameter, for backward compatibility. * New applications should use ConditionExpression instead. Do not * combine legacy parameters and expression parameters in a single API * call; otherwise, DynamoDB will return a ValidationException * exception.

A logical operator to apply to the * conditions in the Expected map:

  • AND - * If all of the conditions evaluate to true, then the entire map * evaluates to true.

  • OR - If at least one of * the conditions evaluate to true, then the entire map evaluates to * true.

If you omit ConditionalOperator, then * AND is the default.

The operation will succeed only if * the entire map evaluates to true.

This parameter does not * support attributes of type List or Map. * * @return A reference to this updated object so that method calls can be chained * together. * * @see ConditionalOperator */ public DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator) { this.conditionalOperator = conditionalOperator.toString(); return this; } /** * Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:

  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

*

* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW * * @return Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:

  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

* * @see ReturnValue */ public String getReturnValues() { return returnValues; } /** * Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:
  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

*

* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW * * @param returnValues Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:

  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

* * @see ReturnValue */ public void setReturnValues(String returnValues) { this.returnValues = returnValues; } /** * Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:
  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

*

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW * * @param returnValues Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:

  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

* * @return A reference to this updated object so that method calls can be chained * together. * * @see ReturnValue */ public DeleteItemRequest withReturnValues(String returnValues) { this.returnValues = returnValues; return this; } /** * Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:
  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

*

* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW * * @param returnValues Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:

  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

* * @see ReturnValue */ public void setReturnValues(ReturnValue returnValues) { this.returnValues = returnValues.toString(); } /** * Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:
  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

*

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW * * @param returnValues Use ReturnValues if you want to get the item attributes as they * appeared before they were deleted. For DeleteItem, the valid * values are:

  • NONE - If ReturnValues is * not specified, or if its value is NONE, then nothing is * returned. (This setting is the default for ReturnValues.)

  • *
  • ALL_OLD - The content of the old item is * returned.

* * @return A reference to this updated object so that method calls can be chained * together. * * @see ReturnValue */ public DeleteItemRequest withReturnValues(ReturnValue returnValues) { this.returnValues = returnValues.toString(); return this; } /** * A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @return A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. * * @see ReturnConsumedCapacity */ public String getReturnConsumedCapacity() { return returnConsumedCapacity; } /** * A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @param returnConsumedCapacity A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. * * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; } /** * A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. *

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @param returnConsumedCapacity A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. * * @return A reference to this updated object so that method calls can be chained * together. * * @see ReturnConsumedCapacity */ public DeleteItemRequest withReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; return this; } /** * A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @param returnConsumedCapacity A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. * * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); } /** * A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. *

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @param returnConsumedCapacity A value that if set to TOTAL, the response includes * ConsumedCapacity data for tables and indexes. If set to * INDEXES, the response includes ConsumedCapacity * for indexes. If set to NONE (the default), * ConsumedCapacity is not included in the response. * * @return A reference to this updated object so that method calls can be chained * together. * * @see ReturnConsumedCapacity */ public DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); return this; } /** * A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. *

* Constraints:
* Allowed Values: SIZE, NONE * * @return A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. * * @see ReturnItemCollectionMetrics */ public String getReturnItemCollectionMetrics() { return returnItemCollectionMetrics; } /** * A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. *

* Constraints:
* Allowed Values: SIZE, NONE * * @param returnItemCollectionMetrics A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. * * @see ReturnItemCollectionMetrics */ public void setReturnItemCollectionMetrics(String returnItemCollectionMetrics) { this.returnItemCollectionMetrics = returnItemCollectionMetrics; } /** * A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. *

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Allowed Values: SIZE, NONE * * @param returnItemCollectionMetrics A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. * * @return A reference to this updated object so that method calls can be chained * together. * * @see ReturnItemCollectionMetrics */ public DeleteItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics) { this.returnItemCollectionMetrics = returnItemCollectionMetrics; return this; } /** * A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. *

* Constraints:
* Allowed Values: SIZE, NONE * * @param returnItemCollectionMetrics A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. * * @see ReturnItemCollectionMetrics */ public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) { this.returnItemCollectionMetrics = returnItemCollectionMetrics.toString(); } /** * A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. *

* Returns a reference to this object so that method calls can be chained together. *

* Constraints:
* Allowed Values: SIZE, NONE * * @param returnItemCollectionMetrics A value that if set to SIZE, the response includes * statistics about item collections, if any, that were modified during * the operation are returned in the response. If set to * NONE (the default), no statistics are returned. * * @return A reference to this updated object so that method calls can be chained * together. * * @see ReturnItemCollectionMetrics */ public DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) { this.returnItemCollectionMetrics = returnItemCollectionMetrics.toString(); return this; } /** * A condition that must be satisfied in order for a conditional * DeleteItem to succeed.

An expression can contain any of the * following:

  • Functions: attribute_exists | * attribute_not_exists | attribute_type | contains | begins_with | * size

    These function names are case-sensitive.

  • *

    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | * IN

  • Logical operators: AND | OR | * NOT

For more information on condition * expressions, see Specifying * Conditions in the Amazon DynamoDB Developer Guide. *

ConditionExpression replaces the legacy * ConditionalOperator and Expected parameters. * * @return A condition that must be satisfied in order for a conditional * DeleteItem to succeed.

An expression can contain any of the * following:

  • Functions: attribute_exists | * attribute_not_exists | attribute_type | contains | begins_with | * size

    These function names are case-sensitive.

  • *

    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | * IN

  • Logical operators: AND | OR | * NOT

For more information on condition * expressions, see Specifying * Conditions in the Amazon DynamoDB Developer Guide. *

ConditionExpression replaces the legacy * ConditionalOperator and Expected parameters. */ public String getConditionExpression() { return conditionExpression; } /** * A condition that must be satisfied in order for a conditional * DeleteItem to succeed.

An expression can contain any of the * following:

  • Functions: attribute_exists | * attribute_not_exists | attribute_type | contains | begins_with | * size

    These function names are case-sensitive.

  • *

    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | * IN

  • Logical operators: AND | OR | * NOT

For more information on condition * expressions, see Specifying * Conditions in the Amazon DynamoDB Developer Guide. *

ConditionExpression replaces the legacy * ConditionalOperator and Expected parameters. * * @param conditionExpression A condition that must be satisfied in order for a conditional * DeleteItem to succeed.

An expression can contain any of the * following:

  • Functions: attribute_exists | * attribute_not_exists | attribute_type | contains | begins_with | * size

    These function names are case-sensitive.

  • *

    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | * IN

  • Logical operators: AND | OR | * NOT

For more information on condition * expressions, see Specifying * Conditions in the Amazon DynamoDB Developer Guide. *

ConditionExpression replaces the legacy * ConditionalOperator and Expected parameters. */ public void setConditionExpression(String conditionExpression) { this.conditionExpression = conditionExpression; } /** * A condition that must be satisfied in order for a conditional * DeleteItem to succeed.

An expression can contain any of the * following:

  • Functions: attribute_exists | * attribute_not_exists | attribute_type | contains | begins_with | * size

    These function names are case-sensitive.

  • *

    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | * IN

  • Logical operators: AND | OR | * NOT

For more information on condition * expressions, see Specifying * Conditions in the Amazon DynamoDB Developer Guide. *

ConditionExpression replaces the legacy * ConditionalOperator and Expected parameters. *

* Returns a reference to this object so that method calls can be chained together. * * @param conditionExpression A condition that must be satisfied in order for a conditional * DeleteItem to succeed.

An expression can contain any of the * following:

  • Functions: attribute_exists | * attribute_not_exists | attribute_type | contains | begins_with | * size

    These function names are case-sensitive.

  • *

    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | * IN

  • Logical operators: AND | OR | * NOT

For more information on condition * expressions, see Specifying * Conditions in the Amazon DynamoDB Developer Guide. *

ConditionExpression replaces the legacy * ConditionalOperator and Expected parameters. * * @return A reference to this updated object so that method calls can be chained * together. */ public DeleteItemRequest withConditionExpression(String conditionExpression) { this.conditionExpression = conditionExpression; return this; } /** * One or more substitution tokens for attribute names in an expression. * The following are some use cases for using * ExpressionAttributeNames:

  • To access an attribute * whose name conflicts with a DynamoDB reserved word.

  • To * create a placeholder for repeating occurrences of an attribute name in * an expression.

  • To prevent special characters in an * attribute name from being misinterpreted in an expression.

*

Use the # character in an expression to dereference an * attribute name. For example, consider the following attribute name: *

  • Percentile

The name of this * attribute conflicts with a reserved word, so it cannot be used * directly in an expression. (For the complete list of reserved words, * see Reserved * Words in the Amazon DynamoDB Developer Guide). To work * around this, you could specify the following for * ExpressionAttributeNames: *

  • {"#P":"Percentile"}

You could * then use this substitution in an expression, as in this example: *

  • #P = :val

Tokens that begin * with the : character are expression attribute values, * which are placeholders for the actual value at runtime.

For * more information on expression attribute names, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. * * @return One or more substitution tokens for attribute names in an expression. * The following are some use cases for using * ExpressionAttributeNames:

  • To access an attribute * whose name conflicts with a DynamoDB reserved word.

  • To * create a placeholder for repeating occurrences of an attribute name in * an expression.

  • To prevent special characters in an * attribute name from being misinterpreted in an expression.

*

Use the # character in an expression to dereference an * attribute name. For example, consider the following attribute name: *

  • Percentile

The name of this * attribute conflicts with a reserved word, so it cannot be used * directly in an expression. (For the complete list of reserved words, * see Reserved * Words in the Amazon DynamoDB Developer Guide). To work * around this, you could specify the following for * ExpressionAttributeNames: *

  • {"#P":"Percentile"}

You could * then use this substitution in an expression, as in this example: *

  • #P = :val

Tokens that begin * with the : character are expression attribute values, * which are placeholders for the actual value at runtime.

For * more information on expression attribute names, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. */ public java.util.Map getExpressionAttributeNames() { return expressionAttributeNames; } /** * One or more substitution tokens for attribute names in an expression. * The following are some use cases for using * ExpressionAttributeNames:

  • To access an attribute * whose name conflicts with a DynamoDB reserved word.

  • To * create a placeholder for repeating occurrences of an attribute name in * an expression.

  • To prevent special characters in an * attribute name from being misinterpreted in an expression.

*

Use the # character in an expression to dereference an * attribute name. For example, consider the following attribute name: *

  • Percentile

The name of this * attribute conflicts with a reserved word, so it cannot be used * directly in an expression. (For the complete list of reserved words, * see Reserved * Words in the Amazon DynamoDB Developer Guide). To work * around this, you could specify the following for * ExpressionAttributeNames: *

  • {"#P":"Percentile"}

You could * then use this substitution in an expression, as in this example: *

  • #P = :val

Tokens that begin * with the : character are expression attribute values, * which are placeholders for the actual value at runtime.

For * more information on expression attribute names, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. * * @param expressionAttributeNames One or more substitution tokens for attribute names in an expression. * The following are some use cases for using * ExpressionAttributeNames:

  • To access an attribute * whose name conflicts with a DynamoDB reserved word.

  • To * create a placeholder for repeating occurrences of an attribute name in * an expression.

  • To prevent special characters in an * attribute name from being misinterpreted in an expression.

*

Use the # character in an expression to dereference an * attribute name. For example, consider the following attribute name: *

  • Percentile

The name of this * attribute conflicts with a reserved word, so it cannot be used * directly in an expression. (For the complete list of reserved words, * see Reserved * Words in the Amazon DynamoDB Developer Guide). To work * around this, you could specify the following for * ExpressionAttributeNames: *

  • {"#P":"Percentile"}

You could * then use this substitution in an expression, as in this example: *

  • #P = :val

Tokens that begin * with the : character are expression attribute values, * which are placeholders for the actual value at runtime.

For * more information on expression attribute names, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. */ public void setExpressionAttributeNames(java.util.Map expressionAttributeNames) { this.expressionAttributeNames = expressionAttributeNames; } /** * One or more substitution tokens for attribute names in an expression. * The following are some use cases for using * ExpressionAttributeNames:

  • To access an attribute * whose name conflicts with a DynamoDB reserved word.

  • To * create a placeholder for repeating occurrences of an attribute name in * an expression.

  • To prevent special characters in an * attribute name from being misinterpreted in an expression.

*

Use the # character in an expression to dereference an * attribute name. For example, consider the following attribute name: *

  • Percentile

The name of this * attribute conflicts with a reserved word, so it cannot be used * directly in an expression. (For the complete list of reserved words, * see Reserved * Words in the Amazon DynamoDB Developer Guide). To work * around this, you could specify the following for * ExpressionAttributeNames: *

  • {"#P":"Percentile"}

You could * then use this substitution in an expression, as in this example: *

  • #P = :val

Tokens that begin * with the : character are expression attribute values, * which are placeholders for the actual value at runtime.

For * more information on expression attribute names, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. *

* Returns a reference to this object so that method calls can be chained together. * * @param expressionAttributeNames One or more substitution tokens for attribute names in an expression. * The following are some use cases for using * ExpressionAttributeNames:

  • To access an attribute * whose name conflicts with a DynamoDB reserved word.

  • To * create a placeholder for repeating occurrences of an attribute name in * an expression.

  • To prevent special characters in an * attribute name from being misinterpreted in an expression.

*

Use the # character in an expression to dereference an * attribute name. For example, consider the following attribute name: *

  • Percentile

The name of this * attribute conflicts with a reserved word, so it cannot be used * directly in an expression. (For the complete list of reserved words, * see Reserved * Words in the Amazon DynamoDB Developer Guide). To work * around this, you could specify the following for * ExpressionAttributeNames: *

  • {"#P":"Percentile"}

You could * then use this substitution in an expression, as in this example: *

  • #P = :val

Tokens that begin * with the : character are expression attribute values, * which are placeholders for the actual value at runtime.

For * more information on expression attribute names, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. * * @return A reference to this updated object so that method calls can be chained * together. */ public DeleteItemRequest withExpressionAttributeNames(java.util.Map expressionAttributeNames) { setExpressionAttributeNames(expressionAttributeNames); return this; } /** * One or more substitution tokens for attribute names in an expression. * The following are some use cases for using * ExpressionAttributeNames:

  • To access an attribute * whose name conflicts with a DynamoDB reserved word.

  • To * create a placeholder for repeating occurrences of an attribute name in * an expression.

  • To prevent special characters in an * attribute name from being misinterpreted in an expression.

*

Use the # character in an expression to dereference an * attribute name. For example, consider the following attribute name: *

  • Percentile

The name of this * attribute conflicts with a reserved word, so it cannot be used * directly in an expression. (For the complete list of reserved words, * see Reserved * Words in the Amazon DynamoDB Developer Guide). To work * around this, you could specify the following for * ExpressionAttributeNames: *

  • {"#P":"Percentile"}

You could * then use this substitution in an expression, as in this example: *

  • #P = :val

Tokens that begin * with the : character are expression attribute values, * which are placeholders for the actual value at runtime.

For * more information on expression attribute names, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. *

* The method adds a new key-value pair into ExpressionAttributeNames * parameter, and returns a reference to this object so that method calls * can be chained together. * * @param key The key of the entry to be added into ExpressionAttributeNames. * @param value The corresponding value of the entry to be added into ExpressionAttributeNames. */ public DeleteItemRequest addExpressionAttributeNamesEntry(String key, String value) { if (null == this.expressionAttributeNames) { this.expressionAttributeNames = new java.util.HashMap(); } if (this.expressionAttributeNames.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expressionAttributeNames.put(key, value); return this; } /** * Removes all the entries added into ExpressionAttributeNames. *

* Returns a reference to this object so that method calls can be chained together. */ public DeleteItemRequest clearExpressionAttributeNamesEntries() { this.expressionAttributeNames = null; return this; } /** * One or more values that can be substituted in an expression.

Use * the : (colon) character in an expression to dereference an * attribute value. For example, suppose that you wanted to check whether * the value of the ProductStatus attribute was one of the * following:

Available | Backordered | Discontinued *

You would first need to specify ExpressionAttributeValues as * follows:

{ ":avail":{"S":"Available"}, * ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

You could then use these values in an expression, such as this: *

ProductStatus IN (:avail, :back, :disc)

For more * information on expression attribute values, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. * * @return One or more values that can be substituted in an expression.

Use * the : (colon) character in an expression to dereference an * attribute value. For example, suppose that you wanted to check whether * the value of the ProductStatus attribute was one of the * following:

Available | Backordered | Discontinued *

You would first need to specify ExpressionAttributeValues as * follows:

{ ":avail":{"S":"Available"}, * ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

You could then use these values in an expression, such as this: *

ProductStatus IN (:avail, :back, :disc)

For more * information on expression attribute values, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. */ public java.util.Map getExpressionAttributeValues() { return expressionAttributeValues; } /** * One or more values that can be substituted in an expression.

Use * the : (colon) character in an expression to dereference an * attribute value. For example, suppose that you wanted to check whether * the value of the ProductStatus attribute was one of the * following:

Available | Backordered | Discontinued *

You would first need to specify ExpressionAttributeValues as * follows:

{ ":avail":{"S":"Available"}, * ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

You could then use these values in an expression, such as this: *

ProductStatus IN (:avail, :back, :disc)

For more * information on expression attribute values, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. * * @param expressionAttributeValues One or more values that can be substituted in an expression.

Use * the : (colon) character in an expression to dereference an * attribute value. For example, suppose that you wanted to check whether * the value of the ProductStatus attribute was one of the * following:

Available | Backordered | Discontinued *

You would first need to specify ExpressionAttributeValues as * follows:

{ ":avail":{"S":"Available"}, * ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

You could then use these values in an expression, such as this: *

ProductStatus IN (:avail, :back, :disc)

For more * information on expression attribute values, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. */ public void setExpressionAttributeValues(java.util.Map expressionAttributeValues) { this.expressionAttributeValues = expressionAttributeValues; } /** * One or more values that can be substituted in an expression.

Use * the : (colon) character in an expression to dereference an * attribute value. For example, suppose that you wanted to check whether * the value of the ProductStatus attribute was one of the * following:

Available | Backordered | Discontinued *

You would first need to specify ExpressionAttributeValues as * follows:

{ ":avail":{"S":"Available"}, * ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

You could then use these values in an expression, such as this: *

ProductStatus IN (:avail, :back, :disc)

For more * information on expression attribute values, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. *

* Returns a reference to this object so that method calls can be chained together. * * @param expressionAttributeValues One or more values that can be substituted in an expression.

Use * the : (colon) character in an expression to dereference an * attribute value. For example, suppose that you wanted to check whether * the value of the ProductStatus attribute was one of the * following:

Available | Backordered | Discontinued *

You would first need to specify ExpressionAttributeValues as * follows:

{ ":avail":{"S":"Available"}, * ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

You could then use these values in an expression, such as this: *

ProductStatus IN (:avail, :back, :disc)

For more * information on expression attribute values, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. * * @return A reference to this updated object so that method calls can be chained * together. */ public DeleteItemRequest withExpressionAttributeValues(java.util.Map expressionAttributeValues) { setExpressionAttributeValues(expressionAttributeValues); return this; } /** * One or more values that can be substituted in an expression.

Use * the : (colon) character in an expression to dereference an * attribute value. For example, suppose that you wanted to check whether * the value of the ProductStatus attribute was one of the * following:

Available | Backordered | Discontinued *

You would first need to specify ExpressionAttributeValues as * follows:

{ ":avail":{"S":"Available"}, * ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

You could then use these values in an expression, such as this: *

ProductStatus IN (:avail, :back, :disc)

For more * information on expression attribute values, see Using * Placeholders for Attribute Names and Values in the Amazon * DynamoDB Developer Guide. *

* The method adds a new key-value pair into ExpressionAttributeValues * parameter, and returns a reference to this object so that method calls * can be chained together. * * @param key The key of the entry to be added into ExpressionAttributeValues. * @param value The corresponding value of the entry to be added into ExpressionAttributeValues. */ public DeleteItemRequest addExpressionAttributeValuesEntry(String key, AttributeValue value) { if (null == this.expressionAttributeValues) { this.expressionAttributeValues = new java.util.HashMap(); } if (this.expressionAttributeValues.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expressionAttributeValues.put(key, value); return this; } /** * Removes all the entries added into ExpressionAttributeValues. *

* Returns a reference to this object so that method calls can be chained together. */ public DeleteItemRequest clearExpressionAttributeValuesEntries() { this.expressionAttributeValues = null; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getTableName() != null) sb.append("TableName: " + getTableName() + ","); if (getKey() != null) sb.append("Key: " + getKey() + ","); if (getExpected() != null) sb.append("Expected: " + getExpected() + ","); if (getConditionalOperator() != null) sb.append("ConditionalOperator: " + getConditionalOperator() + ","); if (getReturnValues() != null) sb.append("ReturnValues: " + getReturnValues() + ","); if (getReturnConsumedCapacity() != null) sb.append("ReturnConsumedCapacity: " + getReturnConsumedCapacity() + ","); if (getReturnItemCollectionMetrics() != null) sb.append("ReturnItemCollectionMetrics: " + getReturnItemCollectionMetrics() + ","); if (getConditionExpression() != null) sb.append("ConditionExpression: " + getConditionExpression() + ","); if (getExpressionAttributeNames() != null) sb.append("ExpressionAttributeNames: " + getExpressionAttributeNames() + ","); if (getExpressionAttributeValues() != null) sb.append("ExpressionAttributeValues: " + getExpressionAttributeValues() ); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode()); hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode()); hashCode = prime * hashCode + ((getExpected() == null) ? 0 : getExpected().hashCode()); hashCode = prime * hashCode + ((getConditionalOperator() == null) ? 0 : getConditionalOperator().hashCode()); hashCode = prime * hashCode + ((getReturnValues() == null) ? 0 : getReturnValues().hashCode()); hashCode = prime * hashCode + ((getReturnConsumedCapacity() == null) ? 0 : getReturnConsumedCapacity().hashCode()); hashCode = prime * hashCode + ((getReturnItemCollectionMetrics() == null) ? 0 : getReturnItemCollectionMetrics().hashCode()); hashCode = prime * hashCode + ((getConditionExpression() == null) ? 0 : getConditionExpression().hashCode()); hashCode = prime * hashCode + ((getExpressionAttributeNames() == null) ? 0 : getExpressionAttributeNames().hashCode()); hashCode = prime * hashCode + ((getExpressionAttributeValues() == null) ? 0 : getExpressionAttributeValues().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DeleteItemRequest == false) return false; DeleteItemRequest other = (DeleteItemRequest)obj; if (other.getTableName() == null ^ this.getTableName() == null) return false; if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false) return false; if (other.getKey() == null ^ this.getKey() == null) return false; if (other.getKey() != null && other.getKey().equals(this.getKey()) == false) return false; if (other.getExpected() == null ^ this.getExpected() == null) return false; if (other.getExpected() != null && other.getExpected().equals(this.getExpected()) == false) return false; if (other.getConditionalOperator() == null ^ this.getConditionalOperator() == null) return false; if (other.getConditionalOperator() != null && other.getConditionalOperator().equals(this.getConditionalOperator()) == false) return false; if (other.getReturnValues() == null ^ this.getReturnValues() == null) return false; if (other.getReturnValues() != null && other.getReturnValues().equals(this.getReturnValues()) == false) return false; if (other.getReturnConsumedCapacity() == null ^ this.getReturnConsumedCapacity() == null) return false; if (other.getReturnConsumedCapacity() != null && other.getReturnConsumedCapacity().equals(this.getReturnConsumedCapacity()) == false) return false; if (other.getReturnItemCollectionMetrics() == null ^ this.getReturnItemCollectionMetrics() == null) return false; if (other.getReturnItemCollectionMetrics() != null && other.getReturnItemCollectionMetrics().equals(this.getReturnItemCollectionMetrics()) == false) return false; if (other.getConditionExpression() == null ^ this.getConditionExpression() == null) return false; if (other.getConditionExpression() != null && other.getConditionExpression().equals(this.getConditionExpression()) == false) return false; if (other.getExpressionAttributeNames() == null ^ this.getExpressionAttributeNames() == null) return false; if (other.getExpressionAttributeNames() != null && other.getExpressionAttributeNames().equals(this.getExpressionAttributeNames()) == false) return false; if (other.getExpressionAttributeValues() == null ^ this.getExpressionAttributeValues() == null) return false; if (other.getExpressionAttributeValues() != null && other.getExpressionAttributeValues().equals(this.getExpressionAttributeValues()) == false) return false; return true; } @Override public DeleteItemRequest clone() { return (DeleteItemRequest) super.clone(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy