software.amazon.awssdk.services.dynamodb.model

Class Delete

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.Delete

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Delete.Builder,Delete>

@Generated(value="software.amazon.awssdk:codegen")
public final class Delete
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Delete.Builder,Delete>

Represents a request to perform a DeleteItem operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Delete.Builder

Method Summary

Modifier and Type	Method and Description
static Delete.Builder	builder()
String	conditionExpression() A condition that must be satisfied in order for a conditional delete to succeed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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	hasExpressionAttributeNames() 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).
boolean	hasExpressionAttributeValues() 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).
int	hashCode()
boolean	hasKey() 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).
Map<String,AttributeValue>	key() The primary key of the item to be deleted.
ReturnValuesOnConditionCheckFailure	returnValuesOnConditionCheckFailure() Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails.
String	returnValuesOnConditionCheckFailureAsString() Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails.
List<SdkField<?>>	sdkFields()
static Class<? extends Delete.Builder>	serializableBuilderClass()
String	tableName() Name of the table in which the item to be deleted resides.
Delete.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasKey

public boolean hasKey()

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.

key

public Map<String,AttributeValue> key()

The primary key of the item to be deleted. 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 hasKey() to see if a value was sent in this field.

Returns:

The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.

tableName

public String tableName()

Name of the table in which the item to be deleted resides.

Returns:

Name of the table in which the item to be deleted resides.

conditionExpression

public String conditionExpression()

A condition that must be satisfied in order for a conditional delete to succeed.

Returns:

A condition that must be satisfied in order for a conditional delete to succeed.

hasExpressionAttributeNames

public boolean hasExpressionAttributeNames()

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.

expressionAttributeNames

public Map<String,String> 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.

You can use hasExpressionAttributeNames() to see if a value was sent in this field.

Returns:

One or more substitution tokens for attribute names in an expression.

hasExpressionAttributeValues

public boolean hasExpressionAttributeValues()

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.

expressionAttributeValues

public Map<String,AttributeValue> 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.

You can use hasExpressionAttributeValues() to see if a value was sent in this field.

Returns:

One or more values that can be substituted in an expression.

returnValuesOnConditionCheckFailure

public ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, 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 return ReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from returnValuesOnConditionCheckFailureAsString().

Returns:

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

See Also:

ReturnValuesOnConditionCheckFailure

returnValuesOnConditionCheckFailureAsString

public String returnValuesOnConditionCheckFailureAsString()

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, 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 return ReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from returnValuesOnConditionCheckFailureAsString().

Returns:

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

See Also:

ReturnValuesOnConditionCheckFailure

toBuilder

public Delete.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Delete.Builder,Delete>

builder

public static Delete.Builder builder()

serializableBuilderClass

public static Class<? extends Delete.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo