
com.amazonaws.services.dynamodbv2.model.PutItemRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.dynamodbv2.AmazonDynamoDB#putItem(PutItemRequest) PutItem operation}.
*
* Creates a new item, or replaces an old item with a new item. If an
* item that has the same primary key as the new item already exists in
* the specified table, the new item completely replaces the existing
* item. You can perform a conditional put operation (add a new item if
* one with the specified primary key doesn't exist), or replace an
* existing item if it has certain attribute values.
*
*
* In addition to putting an item, you can also return the item's
* attribute values in the same operation, using the ReturnValues
* parameter.
*
*
* When you add an item, the primary key attribute(s) are the only
* required attributes. Attribute values cannot be null. String and
* Binary type attributes must have lengths greater than zero. Set type
* attributes cannot be empty. Requests with empty values will be
* rejected with a ValidationException exception.
*
*
* You can request that PutItem return either a copy of the
* original item (before the update) or a copy of the updated item (after
* the update). For more information, see the ReturnValues
* description below.
*
*
* NOTE: To prevent a new item from replacing an existing item,
* use a conditional expression that contains the attribute_not_exists
* function with the name of the attribute being used as the partition
* key for the table. Since every record must contain that attribute,
* the attribute_not_exists function will only succeed if no matching
* item exists.
*
*
* For more information about using this API, see
* Working with Items
* in the Amazon DynamoDB Developer Guide .
*
*
* @see com.amazonaws.services.dynamodbv2.AmazonDynamoDB#putItem(PutItemRequest)
*/
public class PutItemRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the table to contain the item.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*/
private String tableName;
/**
* A map of attribute name/value pairs, one for each attribute. Only the
* primary key attributes are required; you can optionally provide other
* attribute name-value pairs for the item.
You must provide all of
* the attributes for the primary key. For example, with a simple primary
* key, you only need to provide a value for the partition key. For a
* composite primary key, you must provide both values for both the
* partition key and the sort key.
If you specify any attributes that
* are part of an index key, then the data types for those attributes
* must match those of the schema in the table's attribute definition.
*
For more information about primary keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*/
private java.util.Map item;
/**
* 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 PutItem
* operation. This parameter does not support attributes of type
* List or Map.
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.
*/
private java.util.Map expected;
/**
* Use ReturnValues if you want to get the item attributes as they
* appeared before they were updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then the
* content of the old item is returned.
*
* Constraints:
* Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
*/
private String returnValues;
/**
* Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE
*/
private String returnConsumedCapacity;
/**
* Determines whether item collection metrics are returned. 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;
/**
* 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;
/**
* A condition that must be satisfied in order for a conditional
* PutItem operation 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 Accessing
* Item Attributes 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 Specifying
* Conditions in the Amazon DynamoDB Developer Guide.
*/
private java.util.Map expressionAttributeValues;
/**
* Default constructor for a new PutItemRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public PutItemRequest() {}
/**
* Constructs a new PutItemRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param tableName The name of the table to contain the item.
* @param item A map of attribute name/value pairs, one for each
* attribute. Only the primary key attributes are required; you can
* optionally provide other attribute name-value pairs for the item.
* You must provide all of the attributes for the primary key. For
* example, with a simple primary key, you only need to provide a value
* for the partition key. For a composite primary key, you must provide
* both values for both the partition key and the sort key.
If you
* specify any attributes that are part of an index key, then the data
* types for those attributes must match those of the schema in the
* table's attribute definition.
For more information about primary
* keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*/
public PutItemRequest(String tableName, java.util.Map item) {
setTableName(tableName);
setItem(item);
}
/**
* Constructs a new PutItemRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param tableName The name of the table to contain the item.
* @param item A map of attribute name/value pairs, one for each
* attribute. Only the primary key attributes are required; you can
* optionally provide other attribute name-value pairs for the item.
* You must provide all of the attributes for the primary key. For
* example, with a simple primary key, you only need to provide a value
* for the partition key. For a composite primary key, you must provide
* both values for both the partition key and the sort key.
If you
* specify any attributes that are part of an index key, then the data
* types for those attributes must match those of the schema in the
* table's attribute definition.
For more information about primary
* keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
* @param returnValues Use ReturnValues if you want to get the
* item attributes as they appeared before they were updated with the
* PutItem request. For PutItem, 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
- If PutItem overwrote an attribute
* name-value pair, then the content of the old item is returned.
*
*/
public PutItemRequest(String tableName, java.util.Map item, String returnValues) {
setTableName(tableName);
setItem(item);
setReturnValues(returnValues);
}
/**
* Constructs a new PutItemRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param tableName The name of the table to contain the item.
* @param item A map of attribute name/value pairs, one for each
* attribute. Only the primary key attributes are required; you can
* optionally provide other attribute name-value pairs for the item.
* You must provide all of the attributes for the primary key. For
* example, with a simple primary key, you only need to provide a value
* for the partition key. For a composite primary key, you must provide
* both values for both the partition key and the sort key.
If you
* specify any attributes that are part of an index key, then the data
* types for those attributes must match those of the schema in the
* table's attribute definition.
For more information about primary
* keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
* @param returnValues Use ReturnValues if you want to get the
* item attributes as they appeared before they were updated with the
* PutItem request. For PutItem, 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
- If PutItem overwrote an attribute
* name-value pair, then the content of the old item is returned.
*
*/
public PutItemRequest(String tableName, java.util.Map item, ReturnValue returnValues) {
this.tableName = tableName;
this.item = item;
this.returnValues = returnValues.toString();
}
/**
* The name of the table to contain the item.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @return The name of the table to contain the item.
*/
public String getTableName() {
return tableName;
}
/**
* The name of the table to contain the item.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @param tableName The name of the table to contain the item.
*/
public void setTableName(String tableName) {
this.tableName = tableName;
}
/**
* The name of the table to contain 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 to contain the item.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutItemRequest withTableName(String tableName) {
this.tableName = tableName;
return this;
}
/**
* A map of attribute name/value pairs, one for each attribute. Only the
* primary key attributes are required; you can optionally provide other
* attribute name-value pairs for the item.
You must provide all of
* the attributes for the primary key. For example, with a simple primary
* key, you only need to provide a value for the partition key. For a
* composite primary key, you must provide both values for both the
* partition key and the sort key.
If you specify any attributes that
* are part of an index key, then the data types for those attributes
* must match those of the schema in the table's attribute definition.
*
For more information about primary keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*
* @return A map of attribute name/value pairs, one for each attribute. Only the
* primary key attributes are required; you can optionally provide other
* attribute name-value pairs for the item.
You must provide all of
* the attributes for the primary key. For example, with a simple primary
* key, you only need to provide a value for the partition key. For a
* composite primary key, you must provide both values for both the
* partition key and the sort key.
If you specify any attributes that
* are part of an index key, then the data types for those attributes
* must match those of the schema in the table's attribute definition.
*
For more information about primary keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*/
public java.util.Map getItem() {
return item;
}
/**
* A map of attribute name/value pairs, one for each attribute. Only the
* primary key attributes are required; you can optionally provide other
* attribute name-value pairs for the item. You must provide all of
* the attributes for the primary key. For example, with a simple primary
* key, you only need to provide a value for the partition key. For a
* composite primary key, you must provide both values for both the
* partition key and the sort key.
If you specify any attributes that
* are part of an index key, then the data types for those attributes
* must match those of the schema in the table's attribute definition.
*
For more information about primary keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*
* @param item A map of attribute name/value pairs, one for each attribute. Only the
* primary key attributes are required; you can optionally provide other
* attribute name-value pairs for the item.
You must provide all of
* the attributes for the primary key. For example, with a simple primary
* key, you only need to provide a value for the partition key. For a
* composite primary key, you must provide both values for both the
* partition key and the sort key.
If you specify any attributes that
* are part of an index key, then the data types for those attributes
* must match those of the schema in the table's attribute definition.
*
For more information about primary keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*/
public void setItem(java.util.Map item) {
this.item = item;
}
/**
* A map of attribute name/value pairs, one for each attribute. Only the
* primary key attributes are required; you can optionally provide other
* attribute name-value pairs for the item. You must provide all of
* the attributes for the primary key. For example, with a simple primary
* key, you only need to provide a value for the partition key. For a
* composite primary key, you must provide both values for both the
* partition key and the sort key.
If you specify any attributes that
* are part of an index key, then the data types for those attributes
* must match those of the schema in the table's attribute definition.
*
For more information about primary keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param item A map of attribute name/value pairs, one for each attribute. Only the
* primary key attributes are required; you can optionally provide other
* attribute name-value pairs for the item.
You must provide all of
* the attributes for the primary key. For example, with a simple primary
* key, you only need to provide a value for the partition key. For a
* composite primary key, you must provide both values for both the
* partition key and the sort key.
If you specify any attributes that
* are part of an index key, then the data types for those attributes
* must match those of the schema in the table's attribute definition.
*
For more information about primary keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutItemRequest withItem(java.util.Map item) {
setItem(item);
return this;
}
/**
* A map of attribute name/value pairs, one for each attribute. Only the
* primary key attributes are required; you can optionally provide other
* attribute name-value pairs for the item. You must provide all of
* the attributes for the primary key. For example, with a simple primary
* key, you only need to provide a value for the partition key. For a
* composite primary key, you must provide both values for both the
* partition key and the sort key.
If you specify any attributes that
* are part of an index key, then the data types for those attributes
* must match those of the schema in the table's attribute definition.
*
For more information about primary keys, see Primary
* Key in the Amazon DynamoDB Developer Guide.
Each element
* in the Item map is an AttributeValue object.
*
* The method adds a new key-value pair into Item parameter, and returns
* a reference to this object so that method calls can be chained
* together.
*
* @param key The key of the entry to be added into Item.
* @param value The corresponding value of the entry to be added into Item.
*/
public PutItemRequest addItemEntry(String key, AttributeValue value) {
if (null == this.item) {
this.item = new java.util.HashMap();
}
if (this.item.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.item.put(key, value);
return this;
}
/**
* Removes all the entries added into Item.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public PutItemRequest clearItemEntries() {
this.item = 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 PutItem
* operation. This parameter does not support attributes of type
* List or Map.
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.
*
* @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 PutItem
* operation. This parameter does not support attributes of type
* List or Map.
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.
*/
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 PutItem
* operation. This parameter does not support attributes of type
* List or Map.
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.
*
* @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 PutItem
* operation. This parameter does not support attributes of type
* List or Map.
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.
*/
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 PutItem
* operation. This parameter does not support attributes of type
* List or Map.
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.
*
* 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 PutItem
* operation. This parameter does not support attributes of type
* List or Map.
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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutItemRequest 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 PutItem
* operation. This parameter does not support attributes of type
* List or Map.
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.
*
* 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 PutItemRequest 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 PutItemRequest clearExpectedEntries() {
this.expected = null;
return this;
}
/**
* Use ReturnValues if you want to get the item attributes as they
* appeared before they were updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 PutItemRequest withReturnValues(String returnValues) {
this.returnValues = returnValues;
return this;
}
/**
* Use ReturnValues if you want to get the item attributes as they
* appeared before they were updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 updated with the PutItem request. For
* PutItem, 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
-
* If PutItem overwrote an attribute name-value pair, then 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 PutItemRequest withReturnValues(ReturnValue returnValues) {
this.returnValues = returnValues.toString();
return this;
}
/**
* Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE
*
* @return Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* @see ReturnConsumedCapacity
*/
public String getReturnConsumedCapacity() {
return returnConsumedCapacity;
}
/**
* Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE
*
* @param returnConsumedCapacity Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* @see ReturnConsumedCapacity
*/
public void setReturnConsumedCapacity(String returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity;
}
/**
* Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are 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 Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ReturnConsumedCapacity
*/
public PutItemRequest withReturnConsumedCapacity(String returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity;
return this;
}
/**
* Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE
*
* @param returnConsumedCapacity Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* @see ReturnConsumedCapacity
*/
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity.toString();
}
/**
* Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are 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 Determines the level of detail about provisioned throughput
* consumption that is returned in the response:
* INDEXES - The response includes the aggregate
* ConsumedCapacity for the operation, together with
* ConsumedCapacity for each table and secondary index that was
* accessed.
Note that some operations, such as GetItem and
* BatchGetItem, do not access any indexes at all. In these cases,
* specifying INDEXES will only return ConsumedCapacity
* information for table(s).
TOTAL - The response
* includes only the aggregate ConsumedCapacity for the
* operation.
NONE - No ConsumedCapacity
* details are included in the response.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ReturnConsumedCapacity
*/
public PutItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity.toString();
return this;
}
/**
* Determines whether item collection metrics are returned. 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 Determines whether item collection metrics are returned. 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;
}
/**
* Determines whether item collection metrics are returned. 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 Determines whether item collection metrics are returned. 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;
}
/**
* Determines whether item collection metrics are returned. 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 Determines whether item collection metrics are returned. 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 PutItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics) {
this.returnItemCollectionMetrics = returnItemCollectionMetrics;
return this;
}
/**
* Determines whether item collection metrics are returned. 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 Determines whether item collection metrics are returned. 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();
}
/**
* Determines whether item collection metrics are returned. 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 Determines whether item collection metrics are returned. 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 PutItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) {
this.returnItemCollectionMetrics = returnItemCollectionMetrics.toString();
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 PutItemRequest 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 PutItemRequest withConditionalOperator(ConditionalOperator conditionalOperator) {
this.conditionalOperator = conditionalOperator.toString();
return this;
}
/**
* A condition that must be satisfied in order for a conditional
* PutItem operation 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
* PutItem operation 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
* PutItem operation 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
* PutItem operation 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
* PutItem operation 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
* PutItem operation 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 PutItemRequest 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 Accessing
* Item Attributes 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 Accessing
* Item Attributes 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 Accessing
* Item Attributes 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 Accessing
* Item Attributes 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 Accessing
* Item Attributes 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 Accessing
* Item Attributes in the Amazon DynamoDB Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutItemRequest 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 Accessing
* Item Attributes 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 PutItemRequest 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 PutItemRequest 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 Specifying
* Conditions 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 Specifying
* Conditions 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 Specifying
* Conditions 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 Specifying
* Conditions 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 Specifying
* Conditions 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 Specifying
* Conditions in the Amazon DynamoDB Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutItemRequest 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 Specifying
* Conditions 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 PutItemRequest 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 PutItemRequest 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 (getItem() != null) sb.append("Item: " + getItem() + ",");
if (getExpected() != null) sb.append("Expected: " + getExpected() + ",");
if (getReturnValues() != null) sb.append("ReturnValues: " + getReturnValues() + ",");
if (getReturnConsumedCapacity() != null) sb.append("ReturnConsumedCapacity: " + getReturnConsumedCapacity() + ",");
if (getReturnItemCollectionMetrics() != null) sb.append("ReturnItemCollectionMetrics: " + getReturnItemCollectionMetrics() + ",");
if (getConditionalOperator() != null) sb.append("ConditionalOperator: " + getConditionalOperator() + ",");
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 + ((getItem() == null) ? 0 : getItem().hashCode());
hashCode = prime * hashCode + ((getExpected() == null) ? 0 : getExpected().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 + ((getConditionalOperator() == null) ? 0 : getConditionalOperator().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 PutItemRequest == false) return false;
PutItemRequest other = (PutItemRequest)obj;
if (other.getTableName() == null ^ this.getTableName() == null) return false;
if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false) return false;
if (other.getItem() == null ^ this.getItem() == null) return false;
if (other.getItem() != null && other.getItem().equals(this.getItem()) == false) return false;
if (other.getExpected() == null ^ this.getExpected() == null) return false;
if (other.getExpected() != null && other.getExpected().equals(this.getExpected()) == false) return false;
if (other.getReturnValues() == null ^ this.getReturnValues() == null) return false;
if (other.getReturnValues() != null && other.getReturnValues().equals(this.getReturnValues()) == false) return false;
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.getConditionalOperator() == null ^ this.getConditionalOperator() == null) return false;
if (other.getConditionalOperator() != null && other.getConditionalOperator().equals(this.getConditionalOperator()) == 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;
}
}