@Generated(value="software.amazon.awssdk:codegen") public final class UpdateItemRequest extends DynamoDbRequest implements ToCopyableBuilder<UpdateItemRequest.Builder,UpdateItemRequest>
 Represents the input of an UpdateItem operation.
 
| Modifier and Type | Class and Description | 
|---|---|
static interface  | 
UpdateItemRequest.Builder  | 
| Modifier and Type | Method and Description | 
|---|---|
Map<String,AttributeValueUpdate> | 
attributeUpdates()
 This is a legacy parameter. 
 | 
static UpdateItemRequest.Builder | 
builder()  | 
ConditionalOperator | 
conditionalOperator()
 This is a legacy parameter. 
 | 
String | 
conditionalOperatorAsString()
 This is a legacy parameter. 
 | 
String | 
conditionExpression()
 A condition that must be satisfied in order for a conditional update to succeed. 
 | 
boolean | 
equals(Object obj)  | 
Map<String,ExpectedAttributeValue> | 
expected()
 This is a legacy parameter. 
 | 
Map<String,String> | 
expressionAttributeNames()
 One or more substitution tokens for attribute names in an expression. 
 | 
Map<String,AttributeValue> | 
expressionAttributeValues()
 One or more values that can be substituted in an expression. 
 | 
<T> Optional<T> | 
getValueForField(String fieldName,
                Class<T> clazz)
Used to retrieve the value of a field from any class that extends  
SdkRequest. | 
int | 
hashCode()  | 
Map<String,AttributeValue> | 
key()
 The primary key of the item to be updated. 
 | 
ReturnConsumedCapacity | 
returnConsumedCapacity()
Returns the value of the ReturnConsumedCapacity property for this object. 
 | 
String | 
returnConsumedCapacityAsString()
Returns the value of the ReturnConsumedCapacity property for this object. 
 | 
ReturnItemCollectionMetrics | 
returnItemCollectionMetrics()
 Determines whether item collection metrics are returned. 
 | 
String | 
returnItemCollectionMetricsAsString()
 Determines whether item collection metrics are returned. 
 | 
ReturnValue | 
returnValues()
 Use  
ReturnValues if you want to get the item attributes as they appear before or after they are
 updated. | 
String | 
returnValuesAsString()
 Use  
ReturnValues if you want to get the item attributes as they appear before or after they are
 updated. | 
static Class<? extends UpdateItemRequest.Builder> | 
serializableBuilderClass()  | 
String | 
tableName()
 The name of the table containing the item to update. 
 | 
UpdateItemRequest.Builder | 
toBuilder()
Take this object and create a builder that contains all of the current property values of this object. 
 | 
String | 
toString()  | 
String | 
updateExpression()
 An expression that defines one or more attributes to be updated, the action to be performed on them, and new
 value(s) for them. 
 | 
overrideConfigurationcopypublic String tableName()
The name of the table containing the item to update.
public Map<String,AttributeValue> key()
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public Map<String,AttributeValueUpdate> attributeUpdates()
 This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
 
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.public Map<String,ExpectedAttributeValue> expected()
 This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
 
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public ConditionalOperator conditionalOperator()
 This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
 
 If the service returns an enum value that is not available in the current SDK version,
 conditionalOperator will return ConditionalOperator.UNKNOWN_TO_SDK_VERSION. The raw value
 returned by the service is available from conditionalOperatorAsString().
 
ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic String conditionalOperatorAsString()
 This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
 
 If the service returns an enum value that is not available in the current SDK version,
 conditionalOperator will return ConditionalOperator.UNKNOWN_TO_SDK_VERSION. The raw value
 returned by the service is available from conditionalOperatorAsString().
 
ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic ReturnValue returnValues()
 Use ReturnValues if you want to get the item attributes as they appear before or after they are
 updated. For UpdateItem, the valid values are:
 
 NONE - If ReturnValues is not specified, or if its value is NONE, then
 nothing is returned. (This setting is the default for ReturnValues.)
 
 ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem
 operation.
 
 UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
 
 ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
 
 UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
 
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The values returned are strongly consistent.
 If the service returns an enum value that is not available in the current SDK version, returnValues will
 return ReturnValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
 returnValuesAsString().
 
ReturnValues if you want to get the item attributes as they appear before or after they
         are updated. For UpdateItem, the valid values are:
         
         NONE - If ReturnValues is not specified, or if its value is NONE,
         then nothing is returned. (This setting is the default for ReturnValues.)
         
         ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem
         operation.
         
         UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem
         operation.
         
         ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem
         operation.
         
         UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem
         operation.
         
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The values returned are strongly consistent.
ReturnValuepublic String returnValuesAsString()
 Use ReturnValues if you want to get the item attributes as they appear before or after they are
 updated. For UpdateItem, the valid values are:
 
 NONE - If ReturnValues is not specified, or if its value is NONE, then
 nothing is returned. (This setting is the default for ReturnValues.)
 
 ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem
 operation.
 
 UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
 
 ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
 
 UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
 
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The values returned are strongly consistent.
 If the service returns an enum value that is not available in the current SDK version, returnValues will
 return ReturnValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
 returnValuesAsString().
 
ReturnValues if you want to get the item attributes as they appear before or after they
         are updated. For UpdateItem, the valid values are:
         
         NONE - If ReturnValues is not specified, or if its value is NONE,
         then nothing is returned. (This setting is the default for ReturnValues.)
         
         ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem
         operation.
         
         UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem
         operation.
         
         ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem
         operation.
         
         UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem
         operation.
         
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The values returned are strongly consistent.
ReturnValuepublic ReturnConsumedCapacity returnConsumedCapacity()
 If the service returns an enum value that is not available in the current SDK version,
 returnConsumedCapacity will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION. The raw value
 returned by the service is available from returnConsumedCapacityAsString().
 
ReturnConsumedCapacitypublic String returnConsumedCapacityAsString()
 If the service returns an enum value that is not available in the current SDK version,
 returnConsumedCapacity will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION. The raw value
 returned by the service is available from returnConsumedCapacityAsString().
 
ReturnConsumedCapacitypublic ReturnItemCollectionMetrics returnItemCollectionMetrics()
 Determines whether item collection metrics are returned. If set to SIZE, the response includes
 statistics about item collections, if any, that were modified during the operation are returned in the response.
 If set to NONE (the default), no statistics are returned.
 
 If the service returns an enum value that is not available in the current SDK version,
 returnItemCollectionMetrics will return ReturnItemCollectionMetrics.UNKNOWN_TO_SDK_VERSION. The
 raw value returned by the service is available from returnItemCollectionMetricsAsString().
 
SIZE, the response
         includes statistics about item collections, if any, that were modified during the operation are returned
         in the response. If set to NONE (the default), no statistics are returned.ReturnItemCollectionMetricspublic String returnItemCollectionMetricsAsString()
 Determines whether item collection metrics are returned. If set to SIZE, the response includes
 statistics about item collections, if any, that were modified during the operation are returned in the response.
 If set to NONE (the default), no statistics are returned.
 
 If the service returns an enum value that is not available in the current SDK version,
 returnItemCollectionMetrics will return ReturnItemCollectionMetrics.UNKNOWN_TO_SDK_VERSION. The
 raw value returned by the service is available from returnItemCollectionMetricsAsString().
 
SIZE, the response
         includes statistics about item collections, if any, that were modified during the operation are returned
         in the response. If set to NONE (the default), no statistics are returned.ReturnItemCollectionMetricspublic String updateExpression()
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
 The following action values are available for UpdateExpression.
 
 SET - Adds one or more attributes and values to an item. If any of these attribute already exist,
 they are replaced by the new values. You can also use SET to add or subtract from an attribute that
 is of type Number. For example: SET myNum = myNum + :val
 
 SET supports the following functions:
 
 if_not_exists (path, operand) - if the item does not contain an attribute at the specified path,
 then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function
 to avoid overwriting an attribute that may already be present in the item.
 
 list_append (operand, operand) - evaluates to a list with a new element added to it. You can append
 the new element to the start or the end of the list by reversing the order of the operands.
 
These function names are case-sensitive.
 REMOVE - Removes one or more attributes from an item.
 
 ADD - Adds the specified value to the item, if the attribute does not already exist. 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 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.
 
 Similarly, if you use ADD for an existing item to increment or decrement an attribute value that
 doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the
 item you want to update doesn't have an attribute named itemcount, but you decide to ADD the
 number 3 to this attribute anyway. 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 Value is also a set, then Value is added to
 the existing set. For example, if the attribute value is the set [1,2], and the ADD
 action specified [3], then the final attribute value is [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 ADD action only supports Number and set data types. In addition, ADD can only be
 used on top-level attributes, not nested attributes.
 
 DELETE - Deletes an element from a set.
 
 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 specifies [a,c], then the
 final attribute value is [b]. Specifying an empty set is an error.
 
 The DELETE action only supports set data types. In addition, DELETE can only be used on
 top-level attributes, not nested attributes.
 
 You can have many actions in a single expression, such as the following:
 SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
 
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
         The following action values are available for UpdateExpression.
         
         SET - Adds one or more attributes and values to an item. If any of these attribute already
         exist, they are replaced by the new values. You can also use SET to add or subtract from an
         attribute that is of type Number. For example: SET myNum = myNum + :val
         
         SET supports the following functions:
         
         if_not_exists (path, operand) - if the item does not contain an attribute at the specified
         path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use
         this function to avoid overwriting an attribute that may already be present in the item.
         
         list_append (operand, operand) - evaluates to a list with a new element added to it. You can
         append the new element to the start or the end of the list by reversing the order of the operands.
         
These function names are case-sensitive.
         REMOVE - Removes one or more attributes from an item.
         
         ADD - Adds the specified value to the item, if the attribute does not already exist. 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
         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.
         
         Similarly, if you use ADD for an existing item to increment or decrement an attribute value
         that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example,
         suppose that the item you want to update doesn't have an attribute named itemcount, but you decide
         to ADD the number 3 to this attribute anyway. 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 Value is also a set, then Value is
         added to the existing set. For example, if the attribute value is the set [1,2], and the
         ADD action specified [3], then the final attribute value is
         [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 ADD action only supports Number and set data types. In addition, ADD can
         only be used on top-level attributes, not nested attributes.
         
         DELETE - Deletes an element from a set.
         
         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 specifies
         [a,c], then the final attribute value is [b]. Specifying an empty set is an
         error.
         
         The DELETE action only supports set data types. In addition, DELETE can only be
         used on top-level attributes, not nested attributes.
         
         You can have many actions in a single expression, such as the following:
         SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
         
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
public String conditionExpression()
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
 Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
 
These function names are case-sensitive.
 Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN 
 
 Logical operators: AND | OR | NOT
 
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
An expression can contain any of the following:
         Functions:
         attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
         
These function names are case-sensitive.
         Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN 
         
         Logical operators: AND | OR | NOT
         
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public Map<String,String> expressionAttributeNames()
 One or more substitution tokens for attribute names in an expression. The following are some use cases for using
 ExpressionAttributeNames:
 
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
 Percentile
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 {"#P":"Percentile"}
 
You could then use this substitution in an expression, as in this example:
 #P = :val
 
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
ExpressionAttributeNames:
         To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
         Percentile
         
         The name of this attribute conflicts with a reserved word, so it cannot be used directly in an
         expression. (For the complete list of reserved words, see Reserved
         Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
         following for ExpressionAttributeNames:
         
         {"#P":"Percentile"}
         
You could then use this substitution in an expression, as in this example:
         #P = :val
         
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public Map<String,AttributeValue> expressionAttributeValues()
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
 Available | Backordered | Discontinued
 
 You would first need to specify ExpressionAttributeValues as follows:
 
 { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
 
You could then use these values in an expression, such as this:
 ProductStatus IN (:avail, :back, :disc)
 
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
         Available | Backordered | Discontinued
         
         You would first need to specify ExpressionAttributeValues as follows:
         
         { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
         
You could then use these values in an expression, such as this:
         ProductStatus IN (:avail, :back, :disc)
         
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public UpdateItemRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<UpdateItemRequest.Builder,UpdateItemRequest>toBuilder in class DynamoDbRequestpublic static UpdateItemRequest.Builder builder()
public static Class<? extends UpdateItemRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
 specified should match the member name from the corresponding service-2.json model specified in the
 codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
 If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
 again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.