Class UpdateItemRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest
-
- software.amazon.awssdk.services.dynamodb.model.UpdateItemRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateItemRequest.Builder,UpdateItemRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateItemRequest extends DynamoDbRequest implements ToCopyableBuilder<UpdateItemRequest.Builder,UpdateItemRequest>
Represents the input of an
UpdateItem
operation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
UpdateItemRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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)
boolean
equalsBySdkFields(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)
boolean
hasAttributeUpdates()
For responses, this returns true if the service returned a value for the AttributeUpdates property.boolean
hasExpected()
For responses, this returns true if the service returned a value for the Expected property.boolean
hasExpressionAttributeNames()
For responses, this returns true if the service returned a value for the ExpressionAttributeNames property.boolean
hasExpressionAttributeValues()
For responses, this returns true if the service returned a value for the ExpressionAttributeValues property.int
hashCode()
boolean
hasKey()
For responses, this returns true if the service returned a value for the Key property.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()
UseReturnValues
if you want to get the item attributes as they appear before or after they are successfully updated.String
returnValuesAsString()
UseReturnValues
if you want to get the item attributes as they appear before or after they are successfully updated.ReturnValuesOnConditionCheckFailure
returnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for anUpdateItem
operation that failed a condition check.String
returnValuesOnConditionCheckFailureAsString()
An optional parameter that returns the item attributes for anUpdateItem
operation that failed a condition check.List<SdkField<?>>
sdkFields()
static Class<? extends UpdateItemRequest.Builder>
serializableBuilderClass()
String
tableName()
The name of the table containing the item to update.UpdateItemRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
updateExpression()
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
tableName
public final String tableName()
The name of the table containing the item to update.
- Returns:
- The name of the table containing the item to update.
-
hasKey
public final boolean hasKey()
For responses, this returns true if the service returned a value for the Key property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
key
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasKey()
method.- Returns:
- 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.
-
hasAttributeUpdates
public final boolean hasAttributeUpdates()
For responses, this returns true if the service returned a value for the AttributeUpdates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
attributeUpdates
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributeUpdates()
method.- Returns:
- This is a legacy parameter. Use
UpdateExpression
instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
-
hasExpected
public final boolean hasExpected()
For responses, this returns true if the service returned a value for the Expected property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
expected
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExpected()
method.- Returns:
- This is a legacy parameter. Use
ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
-
conditionalOperator
public final 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 returnConditionalOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconditionalOperatorAsString()
.- Returns:
- This is a legacy parameter. Use
ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. - See Also:
ConditionalOperator
-
conditionalOperatorAsString
public final 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 returnConditionalOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconditionalOperatorAsString()
.- Returns:
- This is a legacy parameter. Use
ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. - See Also:
ConditionalOperator
-
returnValues
public final ReturnValue returnValues()
Use
ReturnValues
if you want to get the item attributes as they appear before or after they are successfully updated. ForUpdateItem
, the valid values are:-
NONE
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.) -
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 returnReturnValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreturnValuesAsString()
.- Returns:
- Use
ReturnValues
if you want to get the item attributes as they appear before or after they are successfully updated. ForUpdateItem
, the valid values are:-
NONE
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.) -
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.
-
- See Also:
ReturnValue
-
-
returnValuesAsString
public final String returnValuesAsString()
Use
ReturnValues
if you want to get the item attributes as they appear before or after they are successfully updated. ForUpdateItem
, the valid values are:-
NONE
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.) -
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 returnReturnValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreturnValuesAsString()
.- Returns:
- Use
ReturnValues
if you want to get the item attributes as they appear before or after they are successfully updated. ForUpdateItem
, the valid values are:-
NONE
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.) -
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.
-
- See Also:
ReturnValue
-
-
returnConsumedCapacity
public final ReturnConsumedCapacity returnConsumedCapacity()
Returns the value of the ReturnConsumedCapacity property for this object.If the service returns an enum value that is not available in the current SDK version,
returnConsumedCapacity
will returnReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreturnConsumedCapacityAsString()
.- Returns:
- The value of the ReturnConsumedCapacity property for this object.
- See Also:
ReturnConsumedCapacity
-
returnConsumedCapacityAsString
public final String returnConsumedCapacityAsString()
Returns the value of the ReturnConsumedCapacity property for this object.If the service returns an enum value that is not available in the current SDK version,
returnConsumedCapacity
will returnReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreturnConsumedCapacityAsString()
.- Returns:
- The value of the ReturnConsumedCapacity property for this object.
- See Also:
ReturnConsumedCapacity
-
returnItemCollectionMetrics
public final 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 toNONE
(the default), no statistics are returned.If the service returns an enum value that is not available in the current SDK version,
returnItemCollectionMetrics
will returnReturnItemCollectionMetrics.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreturnItemCollectionMetricsAsString()
.- Returns:
- 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 toNONE
(the default), no statistics are returned. - See Also:
ReturnItemCollectionMetrics
-
returnItemCollectionMetricsAsString
public final 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 toNONE
(the default), no statistics are returned.If the service returns an enum value that is not available in the current SDK version,
returnItemCollectionMetrics
will returnReturnItemCollectionMetrics.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreturnItemCollectionMetricsAsString()
.- Returns:
- 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 toNONE
(the default), no statistics are returned. - See Also:
ReturnItemCollectionMetrics
-
updateExpression
public final String updateExpression()
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values 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 attributes already exist, they are replaced by the new values. You can also useSET
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, thenif_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 ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if
Value
is also a number, thenValue
is mathematically added to the existing attribute. IfValue
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 uses0
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 uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute nameditemcount
, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create theitemcount
attribute, set its initial value to0
, and finally add3
to it. The result will be a newitemcount
attribute in the item, with a value of3
. -
If the existing data type is a set and if
Value
is also a set, thenValue
is added to the existing set. For example, if the attribute value is the set[1,2]
, and theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 theDELETE
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.
- Returns:
- An expression that defines one or more attributes to be updated, the action to be performed on them, and
new values 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 attributes already exist, they are replaced by the new values. You can also useSET
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, thenif_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 ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if
Value
is also a number, thenValue
is mathematically added to the existing attribute. IfValue
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 uses0
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 uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute nameditemcount
, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create theitemcount
attribute, set its initial value to0
, and finally add3
to it. The result will be a newitemcount
attribute in the item, with a value of3
. -
If the existing data type is a set and if
Value
is also a set, thenValue
is added to the existing set. For example, if the attribute value is the set[1,2]
, and theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 theDELETE
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.
-
-
-
conditionExpression
public final 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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Returns:
- 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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
-
-
-
hasExpressionAttributeNames
public final boolean hasExpressionAttributeNames()
For responses, this returns true if the service returned a value for the ExpressionAttributeNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
expressionAttributeNames
public final 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 about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExpressionAttributeNames()
method.- Returns:
- 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 about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
-
-
-
hasExpressionAttributeValues
public final boolean hasExpressionAttributeValues()
For responses, this returns true if the service returned a value for the ExpressionAttributeValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
expressionAttributeValues
public final 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 Condition Expressions in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExpressionAttributeValues()
method.- Returns:
- 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 Condition Expressions in the Amazon DynamoDB Developer Guide.
-
returnValuesOnConditionCheckFailure
public final ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for an
UpdateItem
operation that failed a condition check.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.
If the service returns an enum value that is not available in the current SDK version,
returnValuesOnConditionCheckFailure
will returnReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreturnValuesOnConditionCheckFailureAsString()
.- Returns:
- An optional parameter that returns the item attributes for an
UpdateItem
operation that failed a condition check.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.
- See Also:
ReturnValuesOnConditionCheckFailure
-
returnValuesOnConditionCheckFailureAsString
public final String returnValuesOnConditionCheckFailureAsString()
An optional parameter that returns the item attributes for an
UpdateItem
operation that failed a condition check.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.
If the service returns an enum value that is not available in the current SDK version,
returnValuesOnConditionCheckFailure
will returnReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreturnValuesOnConditionCheckFailureAsString()
.- Returns:
- An optional parameter that returns the item attributes for an
UpdateItem
operation that failed a condition check.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.
- See Also:
ReturnValuesOnConditionCheckFailure
-
toBuilder
public UpdateItemRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateItemRequest.Builder,UpdateItemRequest>
- Specified by:
toBuilder
in classDynamoDbRequest
-
builder
public static UpdateItemRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateItemRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-