com.amazonaws.services.dynamodbv2.model

Class DeleteItemRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.DeleteItemRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeleteItemRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a DeleteItem operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteItemRequest() Default constructor for DeleteItemRequest object.
DeleteItemRequest(String tableName, Map<String,AttributeValue> key) Constructs a new DeleteItemRequest object.
DeleteItemRequest(String tableName, Map<String,AttributeValue> key, ReturnValue returnValues) Constructs a new DeleteItemRequest object.
DeleteItemRequest(String tableName, Map<String,AttributeValue> key, String returnValues) Constructs a new DeleteItemRequest object.

Method Summary

Modifier and Type	Method and Description
DeleteItemRequest	addExpectedEntry(String key, ExpectedAttributeValue value)
DeleteItemRequest	addExpressionAttributeNamesEntry(String key, String value)
DeleteItemRequest	addExpressionAttributeValuesEntry(String key, AttributeValue value)
DeleteItemRequest	addKeyEntry(String key, AttributeValue value)
DeleteItemRequest	clearExpectedEntries() Removes all the entries added into Expected.
DeleteItemRequest	clearExpressionAttributeNamesEntries() Removes all the entries added into ExpressionAttributeNames.
DeleteItemRequest	clearExpressionAttributeValuesEntries() Removes all the entries added into ExpressionAttributeValues.
DeleteItemRequest	clearKeyEntries() Removes all the entries added into Key.
DeleteItemRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getConditionalOperator() This is a legacy parameter.
String	getConditionExpression() A condition that must be satisfied in order for a conditional DeleteItem to succeed.
Map<String,ExpectedAttributeValue>	getExpected() This is a legacy parameter.
Map<String,String>	getExpressionAttributeNames() One or more substitution tokens for attribute names in an expression.
Map<String,AttributeValue>	getExpressionAttributeValues() One or more values that can be substituted in an expression.
Map<String,AttributeValue>	getKey() A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
String	getReturnConsumedCapacity()
String	getReturnItemCollectionMetrics() Determines whether item collection metrics are returned.
String	getReturnValues() Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
String	getTableName() The name of the table from which to delete the item.
int	hashCode()
void	setConditionalOperator(ConditionalOperator conditionalOperator) This is a legacy parameter.
void	setConditionalOperator(String conditionalOperator) This is a legacy parameter.
void	setConditionExpression(String conditionExpression) A condition that must be satisfied in order for a conditional DeleteItem to succeed.
void	setExpected(Map<String,ExpectedAttributeValue> expected) This is a legacy parameter.
void	setExpressionAttributeNames(Map<String,String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.
void	setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues) One or more values that can be substituted in an expression.
void	setKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) Set the hash and range key attributes of the item.
void	setKey(Map<String,AttributeValue> key) A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
void	setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
void	setReturnConsumedCapacity(String returnConsumedCapacity)
void	setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) Determines whether item collection metrics are returned.
void	setReturnItemCollectionMetrics(String returnItemCollectionMetrics) Determines whether item collection metrics are returned.
void	setReturnValues(ReturnValue returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
void	setReturnValues(String returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
void	setTableName(String tableName) The name of the table from which to delete the item.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteItemRequest	withConditionalOperator(ConditionalOperator conditionalOperator) This is a legacy parameter.
DeleteItemRequest	withConditionalOperator(String conditionalOperator) This is a legacy parameter.
DeleteItemRequest	withConditionExpression(String conditionExpression) A condition that must be satisfied in order for a conditional DeleteItem to succeed.
DeleteItemRequest	withExpected(Map<String,ExpectedAttributeValue> expected) This is a legacy parameter.
DeleteItemRequest	withExpressionAttributeNames(Map<String,String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.
DeleteItemRequest	withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues) One or more values that can be substituted in an expression.
DeleteItemRequest	withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) Set the hash and range key attributes of the item.
DeleteItemRequest	withKey(Map<String,AttributeValue> key) A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
DeleteItemRequest	withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
DeleteItemRequest	withReturnConsumedCapacity(String returnConsumedCapacity)
DeleteItemRequest	withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) Determines whether item collection metrics are returned.
DeleteItemRequest	withReturnItemCollectionMetrics(String returnItemCollectionMetrics) Determines whether item collection metrics are returned.
DeleteItemRequest	withReturnValues(ReturnValue returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
DeleteItemRequest	withReturnValues(String returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
DeleteItemRequest	withTableName(String tableName) The name of the table from which to delete the item.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteItemRequest

public DeleteItemRequest()

Default constructor for DeleteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

DeleteItemRequest

public DeleteItemRequest(String tableName,
                         Map<String,AttributeValue> key)

Constructs a new DeleteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

tableName - The name of the table from which to delete the item.

key - A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

DeleteItemRequest

public DeleteItemRequest(String tableName,
                         Map<String,AttributeValue> key,
                         String returnValues)

Constructs a new DeleteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

tableName - The name of the table from which to delete the item.

key - A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD .

DeleteItemRequest

public DeleteItemRequest(String tableName,
                         Map<String,AttributeValue> key,
                         ReturnValue returnValues)

Constructs a new DeleteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

tableName - The name of the table from which to delete the item.

key - A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD .

Method Detail

setTableName

public void setTableName(String tableName)

The name of the table from which to delete the item.

Parameters:

tableName - The name of the table from which to delete the item.

getTableName

public String getTableName()

The name of the table from which to delete the item.

Returns:

The name of the table from which to delete the item.

withTableName

public DeleteItemRequest withTableName(String tableName)

The name of the table from which to delete the item.

Parameters:

tableName - The name of the table from which to delete the item.

Returns:

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

getKey

public Map<String,AttributeValue> getKey()

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Returns:

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

setKey

public void setKey(Map<String,AttributeValue> key)

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Parameters:

key - A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

withKey

public DeleteItemRequest withKey(Map<String,AttributeValue> key)

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Parameters:

key - A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Returns:

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

addKeyEntry

public DeleteItemRequest addKeyEntry(String key,
                                     AttributeValue value)

clearKeyEntries

public DeleteItemRequest clearKeyEntries()

Removes all the entries added into Key.

Returns:

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

getExpected

public Map<String,ExpectedAttributeValue> getExpected()

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Returns:

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

setExpected

public void setExpected(Map<String,ExpectedAttributeValue> expected)

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Parameters:

expected - This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

withExpected

public DeleteItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Parameters:

expected - This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Returns:

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

addExpectedEntry

public DeleteItemRequest addExpectedEntry(String key,
                                          ExpectedAttributeValue value)

clearExpectedEntries

public DeleteItemRequest clearExpectedEntries()

Removes all the entries added into Expected.

Returns:

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

setConditionalOperator

public void setConditionalOperator(String conditionalOperator)

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Parameters:

conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

See Also:

ConditionalOperator

getConditionalOperator

public String getConditionalOperator()

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Returns:

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

See Also:

ConditionalOperator

withConditionalOperator

public DeleteItemRequest withConditionalOperator(String conditionalOperator)

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Parameters:

conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Returns:

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

See Also:

ConditionalOperator

setConditionalOperator

public void setConditionalOperator(ConditionalOperator conditionalOperator)

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Parameters:

conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

See Also:

ConditionalOperator

withConditionalOperator

public DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Parameters:

conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Returns:

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

See Also:

ConditionalOperator

setReturnValues

public void setReturnValues(String returnValues)

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD .

See Also:

ReturnValue

getReturnValues

public String getReturnValues()

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

Returns:

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

See Also:

ReturnValue

withReturnValues

public DeleteItemRequest withReturnValues(String returnValues)

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD .

Returns:

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

See Also:

ReturnValue

setReturnValues

public void setReturnValues(ReturnValue returnValues)

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD .

See Also:

ReturnValue

withReturnValues

public DeleteItemRequest withReturnValues(ReturnValue returnValues)

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD .

Returns:

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

See Also:

ReturnValue

setReturnConsumedCapacity

public void setReturnConsumedCapacity(String returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

See Also:

ReturnConsumedCapacity

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

Returns:

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public DeleteItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

Returns:

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

See Also:

ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

Returns:

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

See Also:

ReturnConsumedCapacity

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(String returnItemCollectionMetrics)

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Parameters:

returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

See Also:

ReturnItemCollectionMetrics

getReturnItemCollectionMetrics

public String getReturnItemCollectionMetrics()

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns:

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

See Also:

ReturnItemCollectionMetrics

withReturnItemCollectionMetrics

public DeleteItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics)

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Parameters:

returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns:

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

See Also:

ReturnItemCollectionMetrics

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Parameters:

returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

See Also:

ReturnItemCollectionMetrics

withReturnItemCollectionMetrics

public DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Parameters:

returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns:

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

See Also:

ReturnItemCollectionMetrics

setConditionExpression

public void setConditionExpression(String conditionExpression)

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

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Parameters:

conditionExpression - A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

getConditionExpression

public String getConditionExpression()

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

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Returns:

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

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

withConditionExpression

public DeleteItemRequest withConditionExpression(String conditionExpression)

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

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Parameters:

conditionExpression - A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Returns:

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

getExpressionAttributeNames

public Map<String,String> getExpressionAttributeNames()

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Returns:

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

setExpressionAttributeNames

public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Parameters:

expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

withExpressionAttributeNames

public DeleteItemRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Parameters:

expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Returns:

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

addExpressionAttributeNamesEntry

public DeleteItemRequest addExpressionAttributeNamesEntry(String key,
                                                          String value)

clearExpressionAttributeNamesEntries

public DeleteItemRequest clearExpressionAttributeNamesEntries()

Removes all the entries added into ExpressionAttributeNames.

Returns:

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

getExpressionAttributeValues

public Map<String,AttributeValue> getExpressionAttributeValues()

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

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Returns:

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

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

setExpressionAttributeValues

public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)

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

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Parameters:

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

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

withExpressionAttributeValues

public DeleteItemRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)

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

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Parameters:

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

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Returns:

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

addExpressionAttributeValuesEntry

public DeleteItemRequest addExpressionAttributeValuesEntry(String key,
                                                           AttributeValue value)

clearExpressionAttributeValuesEntries

public DeleteItemRequest clearExpressionAttributeValuesEntries()

Removes all the entries added into ExpressionAttributeValues.

Returns:

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

setKey

public void setKey(Map.Entry<String,AttributeValue> hashKey,
                   Map.Entry<String,AttributeValue> rangeKey)
            throws IllegalArgumentException

Set the hash and range key attributes of the item.

For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.

Parameters:

hashKey - a map entry including the name and value of the primary hash key.

rangeKey - a map entry including the name and value of the primary range key, or null if it is a hash-only table.

Throws:

IllegalArgumentException

withKey

public DeleteItemRequest withKey(Map.Entry<String,AttributeValue> hashKey,
                                 Map.Entry<String,AttributeValue> rangeKey)
                          throws IllegalArgumentException

Set the hash and range key attributes of the item.

For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.

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

Parameters:

hashKey - a map entry including the name and value of the primary hash key.

rangeKey - a map entry including the name and value of the primary range key, or null if it is a hash-only table.

Throws:

IllegalArgumentException

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeleteItemRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()