Class Update
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Update.Builder,
Update>
Represents a request to perform an UpdateItem
operation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Update.Builder
builder()
final String
A condition that must be satisfied in order for a conditional update to succeed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.One or more substitution tokens for attribute names in an expression.final Map
<String, AttributeValue> One or more values that can be substituted in an expression.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExpressionAttributeNames property.final boolean
For responses, this returns true if the service returned a value for the ExpressionAttributeValues property.final int
hashCode()
final boolean
hasKey()
For responses, this returns true if the service returned a value for the Key property.final Map
<String, AttributeValue> key()
The primary key of the item to be updated.UseReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails.final String
UseReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails.static Class
<? extends Update.Builder> final String
Name of the table for theUpdateItem
request.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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.ToCopyableBuilder
copy
-
Method Details
-
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
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
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.
-
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:
- An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
-
tableName
Name of the table for the
UpdateItem
request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.- Returns:
- Name of the table for the
UpdateItem
request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
-
conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
- Returns:
- A condition that must be satisfied in order for a conditional update to succeed.
-
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
One or more substitution tokens for attribute names in an expression.
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.
-
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
One or more values that can be substituted in an expression.
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.
-
returnValuesOnConditionCheckFailure
Use
ReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.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:
- Use
ReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD. - See Also:
-
returnValuesOnConditionCheckFailureAsString
Use
ReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.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:
- Use
ReturnValuesOnConditionCheckFailure
to get the item attributes if theUpdate
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Update.Builder,
Update> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-