Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.dynamodbv2.model
Class UpdateItemRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.dynamodbv2.model.UpdateItemRequest
All Implemented Interfaces:
java.io.Serializable
public class UpdateItemRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the UpdateItem operation.

Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

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

See Also:
AmazonDynamoDB.updateItem(UpdateItemRequest), Serialized Form

Constructor Summary
UpdateItemRequest()
          Default constructor for a new UpdateItemRequest object.
UpdateItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key, java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates)
          Constructs a new UpdateItemRequest object.
UpdateItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key, java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates, ReturnValue returnValues)
          Constructs a new UpdateItemRequest object.
UpdateItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key, java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates, java.lang.String returnValues)
          Constructs a new UpdateItemRequest object.
 
Method Summary
 UpdateItemRequest addAttributeUpdatesEntry(java.lang.String key, AttributeValueUpdate value)
          The names of attributes to be modified, the action to perform on each, and the new value for each.
 UpdateItemRequest addExpectedEntry(java.lang.String key, ExpectedAttributeValue value)
          A map of attribute/condition pairs.
 UpdateItemRequest addKeyEntry(java.lang.String key, AttributeValue value)
          The primary key that defines the item.
 UpdateItemRequest clearAttributeUpdatesEntries()
          Removes all the entries added into AttributeUpdates.
 UpdateItemRequest clearExpectedEntries()
          Removes all the entries added into Expected.
 UpdateItemRequest clearKeyEntries()
          Removes all the entries added into Key.
 boolean equals(java.lang.Object obj)
           
 java.util.Map<java.lang.String,AttributeValueUpdate> getAttributeUpdates()
          The names of attributes to be modified, the action to perform on each, and the new value for each.
 java.lang.String getConditionalOperator()
          A logical operator to apply to the conditions in the Expected map:
 java.util.Map<java.lang.String,ExpectedAttributeValue> getExpected()
          A map of attribute/condition pairs.
 java.util.Map<java.lang.String,AttributeValue> getKey()
          The primary key that defines the item.
 java.lang.String getReturnConsumedCapacity()
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 java.lang.String getReturnItemCollectionMetrics()
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 java.lang.String getReturnValues()
          Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.
 java.lang.String getTableName()
          The name of the table containing the item to update.
 int hashCode()
           
 void setAttributeUpdates(java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates)
          The names of attributes to be modified, the action to perform on each, and the new value for each.
 void setConditionalOperator(ConditionalOperator conditionalOperator)
          A logical operator to apply to the conditions in the Expected map:
 void setConditionalOperator(java.lang.String conditionalOperator)
          A logical operator to apply to the conditions in the Expected map:
 void setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
          A map of attribute/condition pairs.
 void setKey(java.util.Map.Entry<java.lang.String,AttributeValue> hashKey, java.util.Map.Entry<java.lang.String,AttributeValue> rangeKey)
          The primary key that defines the item.
 void setKey(java.util.Map<java.lang.String,AttributeValue> key)
          The primary key that defines the item.
 void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 void setReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 void setReturnValues(ReturnValue returnValues)
          Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.
 void setReturnValues(java.lang.String returnValues)
          Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.
 void setTableName(java.lang.String tableName)
          The name of the table containing the item to update.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 UpdateItemRequest withAttributeUpdates(java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates)
          The names of attributes to be modified, the action to perform on each, and the new value for each.
 UpdateItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
          A logical operator to apply to the conditions in the Expected map:
 UpdateItemRequest withConditionalOperator(java.lang.String conditionalOperator)
          A logical operator to apply to the conditions in the Expected map:
 UpdateItemRequest withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
          A map of attribute/condition pairs.
 UpdateItemRequest withKey(java.util.Map.Entry<java.lang.String,AttributeValue> hashKey, java.util.Map.Entry<java.lang.String,AttributeValue> rangeKey)
          The primary key that defines the item.
 UpdateItemRequest withKey(java.util.Map<java.lang.String,AttributeValue> key)
          The primary key that defines the item.
 UpdateItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 UpdateItemRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 UpdateItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 UpdateItemRequest withReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 UpdateItemRequest withReturnValues(ReturnValue returnValues)
          Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.
 UpdateItemRequest withReturnValues(java.lang.String returnValues)
          Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.
 UpdateItemRequest withTableName(java.lang.String tableName)
          The name of the table containing the item to update.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdateItemRequest

public UpdateItemRequest()
Default constructor for a new UpdateItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

UpdateItemRequest

public UpdateItemRequest(java.lang.String tableName,
                         java.util.Map<java.lang.String,AttributeValue> key,
                         java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates)
Constructs a new UpdateItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
tableName - The name of the table containing the item to update.
key - The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.
attributeUpdates - The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

  • Value - The new value, if applicable, for this attribute.

  • Action - Specifies how to perform the update. Valid values for Action are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

    If an item with the specified Key is found in the table:

    • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

    • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

    • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

      • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

        If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

        In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

      • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

        Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

      This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

    If no item with the specified Key is found:

    • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

    • DELETE - Nothing happens; there is no attribute to delete.

    • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

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.

UpdateItemRequest

public UpdateItemRequest(java.lang.String tableName,
                         java.util.Map<java.lang.String,AttributeValue> key,
                         java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates,
                         java.lang.String returnValues)
Constructs a new UpdateItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
tableName - The name of the table containing the item to update.
key - The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.
attributeUpdates - The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

  • Value - The new value, if applicable, for this attribute.

  • Action - Specifies how to perform the update. Valid values for Action are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

    If an item with the specified Key is found in the table:

    • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

    • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

    • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

      • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

        If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

        In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

      • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

        Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

      This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

    If no item with the specified Key is found:

    • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

    • DELETE - Nothing happens; there is no attribute to delete.

    • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

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.

returnValues - Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

  • UPDATED_OLD - The old versions of only the updated attributes are returned.

  • ALL_NEW - All of the attributes of the new version of the item are returned.

  • UPDATED_NEW - The new versions of only the updated attributes are returned.

UpdateItemRequest

public UpdateItemRequest(java.lang.String tableName,
                         java.util.Map<java.lang.String,AttributeValue> key,
                         java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates,
                         ReturnValue returnValues)
Constructs a new UpdateItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
tableName - The name of the table containing the item to update.
key - The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.
attributeUpdates - The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

  • Value - The new value, if applicable, for this attribute.

  • Action - Specifies how to perform the update. Valid values for Action are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

    If an item with the specified Key is found in the table:

    • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

    • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

    • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

      • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

        If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

        In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

      • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

        Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

      This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

    If no item with the specified Key is found:

    • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

    • DELETE - Nothing happens; there is no attribute to delete.

    • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

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.

returnValues - Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

  • UPDATED_OLD - The old versions of only the updated attributes are returned.

  • ALL_NEW - All of the attributes of the new version of the item are returned.

  • UPDATED_NEW - The new versions of only the updated attributes are returned.

Method Detail

getTableName

public java.lang.String getTableName()
The name of the table containing the item to update.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:
The name of the table containing the item to update.

setTableName

public void setTableName(java.lang.String tableName)
The name of the table containing the item to update.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:
tableName - The name of the table containing the item to update.

withTableName

public UpdateItemRequest withTableName(java.lang.String tableName)
The name of the table containing the item to update.

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

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:
tableName - The name of the table containing the item to update.
Returns:
A reference to this updated object so that method calls can be chained together.

getKey

public java.util.Map<java.lang.String,AttributeValue> getKey()
The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

Returns:
The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

setKey

public void setKey(java.util.Map<java.lang.String,AttributeValue> key)
The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

Parameters:
key - The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

withKey

public UpdateItemRequest withKey(java.util.Map<java.lang.String,AttributeValue> key)
The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

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

Parameters:
key - The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.
Returns:
A reference to this updated object so that method calls can be chained together.

setKey

public void setKey(java.util.Map.Entry<java.lang.String,AttributeValue> hashKey,
                   java.util.Map.Entry<java.lang.String,AttributeValue> rangeKey)
            throws java.lang.IllegalArgumentException
The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

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

Parameters:
hashKey - Primary hash key.
rangeKey - Primary range key. (null if it a hash-only table)
Throws:
java.lang.IllegalArgumentException

withKey

public UpdateItemRequest withKey(java.util.Map.Entry<java.lang.String,AttributeValue> hashKey,
                                 java.util.Map.Entry<java.lang.String,AttributeValue> rangeKey)
                          throws java.lang.IllegalArgumentException
The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

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

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

Parameters:
hashKey - Primary hash key.
rangeKey - Primary range key. (null if it a hash-only table)
Throws:
java.lang.IllegalArgumentException

addKeyEntry

public UpdateItemRequest addKeyEntry(java.lang.String key,
                                     AttributeValue value)
The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

The method adds a new key-value pair into Key parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:
key - The key of the entry to be added into Key.
value - The corresponding value of the entry to be added into Key.

clearKeyEntries

public UpdateItemRequest clearKeyEntries()
Removes all the entries added into Key.

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

getAttributeUpdates

public java.util.Map<java.lang.String,AttributeValueUpdate> getAttributeUpdates()
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

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.

Returns:
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

  • Value - The new value, if applicable, for this attribute.

  • Action - Specifies how to perform the update. Valid values for Action are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

    If an item with the specified Key is found in the table:

    • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

    • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

    • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

      • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

        If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

        In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

      • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

        Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

      This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

    If no item with the specified Key is found:

    • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

    • DELETE - Nothing happens; there is no attribute to delete.

    • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

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.

setAttributeUpdates

public void setAttributeUpdates(java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates)
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

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.

Parameters:
attributeUpdates - The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

  • Value - The new value, if applicable, for this attribute.

  • Action - Specifies how to perform the update. Valid values for Action are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

    If an item with the specified Key is found in the table:

    • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

    • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

    • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

      • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

        If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

        In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

      • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

        Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

      This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

    If no item with the specified Key is found:

    • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

    • DELETE - Nothing happens; there is no attribute to delete.

    • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

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.

withAttributeUpdates

public UpdateItemRequest withAttributeUpdates(java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates)
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

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.

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

Parameters:
attributeUpdates - The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

  • Value - The new value, if applicable, for this attribute.

  • Action - Specifies how to perform the update. Valid values for Action are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

    If an item with the specified Key is found in the table:

    • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

    • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

    • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

      • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

        If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

        In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

      • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

        Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

      This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

    If no item with the specified Key is found:

    • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

    • DELETE - Nothing happens; there is no attribute to delete.

    • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

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.

Returns:
A reference to this updated object so that method calls can be chained together.

addAttributeUpdatesEntry

public UpdateItemRequest addAttributeUpdatesEntry(java.lang.String key,
                                                  AttributeValueUpdate value)
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

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.

The method adds a new key-value pair into AttributeUpdates parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:
key - The key of the entry to be added into AttributeUpdates.
value - The corresponding value of the entry to be added into AttributeUpdates.

clearAttributeUpdatesEntries

public UpdateItemRequest clearAttributeUpdatesEntries()
Removes all the entries added into AttributeUpdates.

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

getExpected

public java.util.Map<java.lang.String,ExpectedAttributeValue> getExpected()
A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation.

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

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

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

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

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

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

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

Returns:
A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation.

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

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

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

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

  • 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 aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

    For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

  • 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.

      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 specified 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.

      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 specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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). If an item contains an AttributeValue of a different type than the one specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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.

    • NULL : The attribute does not exist.

    • CONTAINS : checks for a subsequence, or value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).

    • NOT_CONTAINS : checks for absence of a subsequence, or absence of a value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).

    • BEGINS_WITH : checks for a prefix.

      AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

    • IN : checks for exact matches.

      AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.

    • 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). 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 of a different type than the one specified 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 Conditional Expressions 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 - Causes DynamoDB to evaluate the value vefore 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.???

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

setExpected

public void setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation.

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

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

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

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

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

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

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

Parameters:
expected - A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation.

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

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

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

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

  • 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 aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

    For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

  • 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.

      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 specified 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.

      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 specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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). If an item contains an AttributeValue of a different type than the one specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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.

    • NULL : The attribute does not exist.

    • CONTAINS : checks for a subsequence, or value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).

    • NOT_CONTAINS : checks for absence of a subsequence, or absence of a value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).

    • BEGINS_WITH : checks for a prefix.

      AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

    • IN : checks for exact matches.

      AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.

    • 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). 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 of a different type than the one specified 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 Conditional Expressions 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 - Causes DynamoDB to evaluate the value vefore 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.???

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

withExpected

public UpdateItemRequest withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation.

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

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

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

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

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

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

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

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

Parameters:
expected - A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation.

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

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

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

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

  • 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 aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

    For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

  • 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.

      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 specified 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.

      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 specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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). If an item contains an AttributeValue of a different type than the one specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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 of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified 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.

    • NULL : The attribute does not exist.

    • CONTAINS : checks for a subsequence, or value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).

    • NOT_CONTAINS : checks for absence of a subsequence, or absence of a value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).

    • BEGINS_WITH : checks for a prefix.

      AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

    • IN : checks for exact matches.

      AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.

    • 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). 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 of a different type than the one specified 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 Conditional Expressions 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 - Causes DynamoDB to evaluate the value vefore 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.???

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

Returns:
A reference to this updated object so that method calls can be chained together.

addExpectedEntry

public UpdateItemRequest addExpectedEntry(java.lang.String key,
                                          ExpectedAttributeValue value)
A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation.

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

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

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

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

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

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

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

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.

Parameters:
key - The key of the entry to be added into Expected.
value - The corresponding value of the entry to be added into Expected.

clearExpectedEntries

public UpdateItemRequest clearExpectedEntries()
Removes all the entries added into Expected.

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

getConditionalOperator

public java.lang.String getConditionalOperator()
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

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

Constraints:
Allowed Values: AND, OR

Returns:
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.

See Also:
ConditionalOperator

setConditionalOperator

public void setConditionalOperator(java.lang.String conditionalOperator)
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

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

Constraints:
Allowed Values: AND, OR

Parameters:
conditionalOperator - 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.

See Also:
ConditionalOperator

withConditionalOperator

public UpdateItemRequest withConditionalOperator(java.lang.String conditionalOperator)
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

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

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

Constraints:
Allowed Values: AND, OR

Parameters:
conditionalOperator - 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.

Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ConditionalOperator

setConditionalOperator

public void setConditionalOperator(ConditionalOperator conditionalOperator)
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

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

Constraints:
Allowed Values: AND, OR

Parameters:
conditionalOperator - 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.

See Also:
ConditionalOperator

withConditionalOperator

public UpdateItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

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

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

Constraints:
Allowed Values: AND, OR

Parameters:
conditionalOperator - 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.

Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ConditionalOperator

getReturnValues

public java.lang.String getReturnValues()
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Returns:
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

  • UPDATED_OLD - The old versions of only the updated attributes are returned.

  • ALL_NEW - All of the attributes of the new version of the item are returned.

  • UPDATED_NEW - The new versions of only the updated attributes are returned.

See Also:
ReturnValue

setReturnValues

public void setReturnValues(java.lang.String returnValues)
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Parameters:
returnValues - Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

  • UPDATED_OLD - The old versions of only the updated attributes are returned.

  • ALL_NEW - All of the attributes of the new version of the item are returned.

  • UPDATED_NEW - The new versions of only the updated attributes are returned.

See Also:
ReturnValue

withReturnValues

public UpdateItemRequest withReturnValues(java.lang.String returnValues)
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

Parameters:
returnValues - Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

  • UPDATED_OLD - The old versions of only the updated attributes are returned.

  • ALL_NEW - All of the attributes of the new version of the item are returned.

  • UPDATED_NEW - The new versions of only the updated attributes are returned.

Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnValue

setReturnValues

public void setReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Parameters:
returnValues - Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

  • UPDATED_OLD - The old versions of only the updated attributes are returned.

  • ALL_NEW - All of the attributes of the new version of the item are returned.

  • UPDATED_NEW - The new versions of only the updated attributes are returned.

See Also:
ReturnValue

withReturnValues

public UpdateItemRequest withReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

Parameters:
returnValues - Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

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

  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

  • UPDATED_OLD - The old versions of only the updated attributes are returned.

  • ALL_NEW - All of the attributes of the new version of the item are returned.

  • UPDATED_NEW - The new versions of only the updated attributes are returned.

Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnValue

getReturnConsumedCapacity

public java.lang.String getReturnConsumedCapacity()
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Returns:
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
See Also:
ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:
returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
See Also:
ReturnConsumedCapacity

withReturnConsumedCapacity

public UpdateItemRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

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

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:
returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:
returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
See Also:
ReturnConsumedCapacity

withReturnConsumedCapacity

public UpdateItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

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

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:
returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnConsumedCapacity

getReturnItemCollectionMetrics

public java.lang.String getReturnItemCollectionMetrics()
If set to SIZE, 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

Returns:
If set to SIZE, 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 Also:
ReturnItemCollectionMetrics

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
If set to SIZE, 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

Parameters:
returnItemCollectionMetrics - If set to SIZE, 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 Also:
ReturnItemCollectionMetrics

withReturnItemCollectionMetrics

public UpdateItemRequest withReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
If set to SIZE, 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

Parameters:
returnItemCollectionMetrics - If set to SIZE, 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 updated object so that method calls can be chained together.
See Also:
ReturnItemCollectionMetrics

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
If set to SIZE, 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

Parameters:
returnItemCollectionMetrics - If set to SIZE, 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 Also:
ReturnItemCollectionMetrics

withReturnItemCollectionMetrics

public UpdateItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
If set to SIZE, 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

Parameters:
returnItemCollectionMetrics - If set to SIZE, 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 updated object so that method calls can be chained together.
See Also:
ReturnItemCollectionMetrics

toString

public java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.