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() For responses, this returns true if the service returned a value for the ExpressionAttributeNames property.
boolean	hasExpressionAttributeValues() For responses, this returns true if the service returned a value for the ExpressionAttributeValues property.
int	hashCode()
boolean	hasKey() For responses, this returns true if the service returned a value for the Key property.
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 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 the isEmpty() 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

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

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 deleted. Each element consists of an attribute name and a value for that attribute.

tableName

public final 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 final 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 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 the isEmpty() 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

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

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 the isEmpty() 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

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

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

public final 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 final 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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo