Interface Update.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Update.Builder,
,Update> SdkBuilder<Update.Builder,
,Update> SdkPojo
- Enclosing class:
Update
-
Method Summary
Modifier and TypeMethodDescriptionconditionExpression
(String conditionExpression) A condition that must be satisfied in order for a conditional update to succeed.expressionAttributeNames
(Map<String, String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.expressionAttributeValues
(Map<String, AttributeValue> expressionAttributeValues) One or more values that can be substituted in an expression.key
(Map<String, AttributeValue> key) The primary key of the item to be updated.returnValuesOnConditionCheckFailure
(String returnValuesOnConditionCheckFailure) UseReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails.returnValuesOnConditionCheckFailure
(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) UseReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails.Name of the table for theUpdateItem
request.updateExpression
(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.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
key
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
- Parameters:
key
- The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tableName
Name of the table for the
UpdateItem
request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.- Parameters:
tableName
- Name of the table for theUpdateItem
request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
- Parameters:
conditionExpression
- A condition that must be satisfied in order for a conditional update to succeed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expressionAttributeNames
One or more substitution tokens for attribute names in an expression.
- Parameters:
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expressionAttributeValues
One or more values that can be substituted in an expression.
- Parameters:
expressionAttributeValues
- One or more values that can be substituted in an expression.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
returnValuesOnConditionCheckFailure
Use
ReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.- Parameters:
returnValuesOnConditionCheckFailure
- UseReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
returnValuesOnConditionCheckFailure
Update.Builder returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) Use
ReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.- Parameters:
returnValuesOnConditionCheckFailure
- UseReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-