software.amazon.awssdk.services.dynamodb.model

Interface Update.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Update.Builder,Update>, SdkBuilder<Update.Builder,Update>, SdkPojo

Enclosing class:

Update

public static interface Update.Builder
extends SdkPojo, CopyableBuilder<Update.Builder,Update>

Method Summary

Modifier and Type	Method and Description
Update.Builder	conditionExpression(String conditionExpression) A condition that must be satisfied in order for a conditional update to succeed.
Update.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.
Update.Builder	expressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues) One or more values that can be substituted in an expression.
Update.Builder	key(Map<String,AttributeValue> key) The primary key of the item to be updated.
Update.Builder	returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails.
Update.Builder	returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails.
Update.Builder	tableName(String tableName) Name of the table for the UpdateItem request.
Update.Builder	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.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

key

Update.Builder key(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.

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

Update.Builder 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.

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

Update.Builder tableName(String tableName)

Name of the table for the UpdateItem request.

Parameters:

tableName - Name of the table for the UpdateItem request.

Returns:

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

conditionExpression

Update.Builder conditionExpression(String 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

Update.Builder expressionAttributeNames(Map<String,String> 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

Update.Builder expressionAttributeValues(Map<String,AttributeValue> 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

Update.Builder returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

Parameters:

returnValuesOnConditionCheckFailure - Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

Returns:

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

See Also:

ReturnValuesOnConditionCheckFailure, ReturnValuesOnConditionCheckFailure

returnValuesOnConditionCheckFailure

Update.Builder returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

Parameters:

returnValuesOnConditionCheckFailure - Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

Returns:

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

See Also:

ReturnValuesOnConditionCheckFailure, ReturnValuesOnConditionCheckFailure