software.amazon.awssdk.services.dynamodb.model.Update Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.dynamodb.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents a request to perform an UpdateItem operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Update implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> KEY_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Key")
.getter(getter(Update::key))
.setter(setter(Builder::key))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Key").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField UPDATE_EXPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UpdateExpression").getter(getter(Update::updateExpression)).setter(setter(Builder::updateExpression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpdateExpression").build()).build();
private static final SdkField TABLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TableName").getter(getter(Update::tableName)).setter(setter(Builder::tableName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TableName").build()).build();
private static final SdkField CONDITION_EXPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConditionExpression").getter(getter(Update::conditionExpression))
.setter(setter(Builder::conditionExpression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConditionExpression").build())
.build();
private static final SdkField> EXPRESSION_ATTRIBUTE_NAMES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("ExpressionAttributeNames")
.getter(getter(Update::expressionAttributeNames))
.setter(setter(Builder::expressionAttributeNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExpressionAttributeNames").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> EXPRESSION_ATTRIBUTE_VALUES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("ExpressionAttributeValues")
.getter(getter(Update::expressionAttributeValues))
.setter(setter(Builder::expressionAttributeValues))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExpressionAttributeValues").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField RETURN_VALUES_ON_CONDITION_CHECK_FAILURE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ReturnValuesOnConditionCheckFailure")
.getter(getter(Update::returnValuesOnConditionCheckFailureAsString))
.setter(setter(Builder::returnValuesOnConditionCheckFailure))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ReturnValuesOnConditionCheckFailure").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_FIELD,
UPDATE_EXPRESSION_FIELD, TABLE_NAME_FIELD, CONDITION_EXPRESSION_FIELD, EXPRESSION_ATTRIBUTE_NAMES_FIELD,
EXPRESSION_ATTRIBUTE_VALUES_FIELD, RETURN_VALUES_ON_CONDITION_CHECK_FAILURE_FIELD));
private static final long serialVersionUID = 1L;
private final Map key;
private final String updateExpression;
private final String tableName;
private final String conditionExpression;
private final Map expressionAttributeNames;
private final Map expressionAttributeValues;
private final String returnValuesOnConditionCheckFailure;
private Update(BuilderImpl builder) {
this.key = builder.key;
this.updateExpression = builder.updateExpression;
this.tableName = builder.tableName;
this.conditionExpression = builder.conditionExpression;
this.expressionAttributeNames = builder.expressionAttributeNames;
this.expressionAttributeValues = builder.expressionAttributeValues;
this.returnValuesOnConditionCheckFailure = builder.returnValuesOnConditionCheckFailure;
}
/**
* Returns true if the Key property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasKey() {
return key != null && !(key instanceof SdkAutoConstructMap);
}
/**
*
* 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.
*
*
* You can use {@link #hasKey()} to see if a value was sent in this field.
*
*
* @return The primary key of the item to be updated. Each element consists of an attribute name and a value for
* that attribute.
*/
public final Map key() {
return key;
}
/**
*
* An expression that defines one or more attributes to be updated, the action to be performed on them, and new
* value(s) for them.
*
*
* @return An expression that defines one or more attributes to be updated, the action to be performed on them, and
* new value(s) for them.
*/
public final String updateExpression() {
return updateExpression;
}
/**
*
* Name of the table for the UpdateItem request.
*
*
* @return Name of the table for the UpdateItem request.
*/
public final String tableName() {
return tableName;
}
/**
*
* A condition that must be satisfied in order for a conditional update to succeed.
*
*
* @return A condition that must be satisfied in order for a conditional update to succeed.
*/
public final String conditionExpression() {
return conditionExpression;
}
/**
* Returns true if the ExpressionAttributeNames property was specified by the sender (it may be empty), or false if
* the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public final boolean hasExpressionAttributeNames() {
return expressionAttributeNames != null && !(expressionAttributeNames instanceof SdkAutoConstructMap);
}
/**
*
* 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.
*
*
* You can use {@link #hasExpressionAttributeNames()} to see if a value was sent in this field.
*
*
* @return One or more substitution tokens for attribute names in an expression.
*/
public final Map expressionAttributeNames() {
return expressionAttributeNames;
}
/**
* Returns true if the ExpressionAttributeValues property was specified by the sender (it may be empty), or false if
* the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public final boolean hasExpressionAttributeValues() {
return expressionAttributeValues != null && !(expressionAttributeValues instanceof SdkAutoConstructMap);
}
/**
*
* 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.
*
*
* You can use {@link #hasExpressionAttributeValues()} to see if a value was sent in this field.
*
*
* @return One or more values that can be substituted in an expression.
*/
public final Map expressionAttributeValues() {
return expressionAttributeValues;
}
/**
*
* 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.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #returnValuesOnConditionCheckFailure} will return
* {@link ReturnValuesOnConditionCheckFailure#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #returnValuesOnConditionCheckFailureAsString}.
*
*
* @return 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.
* @see ReturnValuesOnConditionCheckFailure
*/
public final ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure() {
return ReturnValuesOnConditionCheckFailure.fromValue(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.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #returnValuesOnConditionCheckFailure} will return
* {@link ReturnValuesOnConditionCheckFailure#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #returnValuesOnConditionCheckFailureAsString}.
*
*
* @return 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.
* @see ReturnValuesOnConditionCheckFailure
*/
public final String returnValuesOnConditionCheckFailureAsString() {
return returnValuesOnConditionCheckFailure;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasKey() ? key() : null);
hashCode = 31 * hashCode + Objects.hashCode(updateExpression());
hashCode = 31 * hashCode + Objects.hashCode(tableName());
hashCode = 31 * hashCode + Objects.hashCode(conditionExpression());
hashCode = 31 * hashCode + Objects.hashCode(hasExpressionAttributeNames() ? expressionAttributeNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasExpressionAttributeValues() ? expressionAttributeValues() : null);
hashCode = 31 * hashCode + Objects.hashCode(returnValuesOnConditionCheckFailureAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Update)) {
return false;
}
Update other = (Update) obj;
return hasKey() == other.hasKey()
&& Objects.equals(key(), other.key())
&& Objects.equals(updateExpression(), other.updateExpression())
&& Objects.equals(tableName(), other.tableName())
&& Objects.equals(conditionExpression(), other.conditionExpression())
&& hasExpressionAttributeNames() == other.hasExpressionAttributeNames()
&& Objects.equals(expressionAttributeNames(), other.expressionAttributeNames())
&& hasExpressionAttributeValues() == other.hasExpressionAttributeValues()
&& Objects.equals(expressionAttributeValues(), other.expressionAttributeValues())
&& Objects.equals(returnValuesOnConditionCheckFailureAsString(),
other.returnValuesOnConditionCheckFailureAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Update").add("Key", hasKey() ? key() : null).add("UpdateExpression", updateExpression())
.add("TableName", tableName()).add("ConditionExpression", conditionExpression())
.add("ExpressionAttributeNames", hasExpressionAttributeNames() ? expressionAttributeNames() : null)
.add("ExpressionAttributeValues", hasExpressionAttributeValues() ? expressionAttributeValues() : null)
.add("ReturnValuesOnConditionCheckFailure", returnValuesOnConditionCheckFailureAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Key":
return Optional.ofNullable(clazz.cast(key()));
case "UpdateExpression":
return Optional.ofNullable(clazz.cast(updateExpression()));
case "TableName":
return Optional.ofNullable(clazz.cast(tableName()));
case "ConditionExpression":
return Optional.ofNullable(clazz.cast(conditionExpression()));
case "ExpressionAttributeNames":
return Optional.ofNullable(clazz.cast(expressionAttributeNames()));
case "ExpressionAttributeValues":
return Optional.ofNullable(clazz.cast(expressionAttributeValues()));
case "ReturnValuesOnConditionCheckFailure":
return Optional.ofNullable(clazz.cast(returnValuesOnConditionCheckFailureAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Update) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The primary key of the item to be updated. Each element consists of an attribute name and a value for that
* attribute.
*
*
* @param key
* The primary key of the item to be updated. Each element consists of an attribute name and a value for
* that attribute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder key(Map key);
/**
*
* An expression that defines one or more attributes to be updated, the action to be performed on them, and new
* value(s) for them.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updateExpression(String updateExpression);
/**
*
* Name of the table for the UpdateItem request.
*
*
* @param tableName
* Name of the table for the UpdateItem request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tableName(String tableName);
/**
*
* A condition that must be satisfied in order for a conditional update to succeed.
*
*
* @param conditionExpression
* A condition that must be satisfied in order for a conditional update to succeed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder conditionExpression(String conditionExpression);
/**
*
* One or more substitution tokens for attribute names in an expression.
*
*
* @param expressionAttributeNames
* One or more substitution tokens for attribute names in an expression.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expressionAttributeNames(Map expressionAttributeNames);
/**
*
* One or more values that can be substituted in an expression.
*
*
* @param expressionAttributeValues
* One or more values that can be substituted in an expression.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expressionAttributeValues(Map expressionAttributeValues);
/**
*
* 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.
*
*
* @param 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.
* @see ReturnValuesOnConditionCheckFailure
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnValuesOnConditionCheckFailure
*/
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.
*
*
* @param 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.
* @see ReturnValuesOnConditionCheckFailure
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnValuesOnConditionCheckFailure
*/
Builder returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure);
}
static final class BuilderImpl implements Builder {
private Map key = DefaultSdkAutoConstructMap.getInstance();
private String updateExpression;
private String tableName;
private String conditionExpression;
private Map expressionAttributeNames = DefaultSdkAutoConstructMap.getInstance();
private Map expressionAttributeValues = DefaultSdkAutoConstructMap.getInstance();
private String returnValuesOnConditionCheckFailure;
private BuilderImpl() {
}
private BuilderImpl(Update model) {
key(model.key);
updateExpression(model.updateExpression);
tableName(model.tableName);
conditionExpression(model.conditionExpression);
expressionAttributeNames(model.expressionAttributeNames);
expressionAttributeValues(model.expressionAttributeValues);
returnValuesOnConditionCheckFailure(model.returnValuesOnConditionCheckFailure);
}
public final Map getKey() {
Map result = KeyCopier.copyToBuilder(this.key);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
@Override
public final Builder key(Map key) {
this.key = KeyCopier.copy(key);
return this;
}
public final void setKey(Map key) {
this.key = KeyCopier.copyFromBuilder(key);
}
public final String getUpdateExpression() {
return updateExpression;
}
@Override
public final Builder updateExpression(String updateExpression) {
this.updateExpression = updateExpression;
return this;
}
public final void setUpdateExpression(String updateExpression) {
this.updateExpression = updateExpression;
}
public final String getTableName() {
return tableName;
}
@Override
public final Builder tableName(String tableName) {
this.tableName = tableName;
return this;
}
public final void setTableName(String tableName) {
this.tableName = tableName;
}
public final String getConditionExpression() {
return conditionExpression;
}
@Override
public final Builder conditionExpression(String conditionExpression) {
this.conditionExpression = conditionExpression;
return this;
}
public final void setConditionExpression(String conditionExpression) {
this.conditionExpression = conditionExpression;
}
public final Map getExpressionAttributeNames() {
if (expressionAttributeNames instanceof SdkAutoConstructMap) {
return null;
}
return expressionAttributeNames;
}
@Override
public final Builder expressionAttributeNames(Map expressionAttributeNames) {
this.expressionAttributeNames = ExpressionAttributeNameMapCopier.copy(expressionAttributeNames);
return this;
}
public final void setExpressionAttributeNames(Map expressionAttributeNames) {
this.expressionAttributeNames = ExpressionAttributeNameMapCopier.copy(expressionAttributeNames);
}
public final Map getExpressionAttributeValues() {
Map result = ExpressionAttributeValueMapCopier
.copyToBuilder(this.expressionAttributeValues);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
@Override
public final Builder expressionAttributeValues(Map expressionAttributeValues) {
this.expressionAttributeValues = ExpressionAttributeValueMapCopier.copy(expressionAttributeValues);
return this;
}
public final void setExpressionAttributeValues(Map expressionAttributeValues) {
this.expressionAttributeValues = ExpressionAttributeValueMapCopier.copyFromBuilder(expressionAttributeValues);
}
public final String getReturnValuesOnConditionCheckFailure() {
return returnValuesOnConditionCheckFailure;
}
@Override
public final Builder returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) {
this.returnValuesOnConditionCheckFailure = returnValuesOnConditionCheckFailure;
return this;
}
@Override
public final Builder returnValuesOnConditionCheckFailure(
ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) {
this.returnValuesOnConditionCheckFailure(returnValuesOnConditionCheckFailure == null ? null
: returnValuesOnConditionCheckFailure.toString());
return this;
}
public final void setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) {
this.returnValuesOnConditionCheckFailure = returnValuesOnConditionCheckFailure;
}
@Override
public Update build() {
return new Update(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy