Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.dynamodbv2.model
Class DeleteItemRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.dynamodbv2.model.DeleteItemRequest
All Implemented Interfaces:
java.io.Serializable
public class DeleteItemRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the DeleteItem operation.

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for only deleting items if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

See Also:
AmazonDynamoDB.deleteItem(DeleteItemRequest), Serialized Form

Constructor Summary
DeleteItemRequest()
          Default constructor for a new DeleteItemRequest object.
DeleteItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key)
          Constructs a new DeleteItemRequest object.
DeleteItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key, ReturnValue returnValues)
          Constructs a new DeleteItemRequest object.
DeleteItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key, java.lang.String returnValues)
          Constructs a new DeleteItemRequest object.
 
Method Summary
 DeleteItemRequest addExpectedEntry(java.lang.String key, ExpectedAttributeValue value)
          A map of attribute/condition pairs.
 DeleteItemRequest addKeyEntry(java.lang.String key, AttributeValue value)
          A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
 DeleteItemRequest clearExpectedEntries()
          Removes all the entries added into Expected.
 DeleteItemRequest clearKeyEntries()
          Removes all the entries added into Key.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getConditionalOperator()
          A logical operator to apply to the conditions in the Expected map:
 java.util.Map<java.lang.String,ExpectedAttributeValue> getExpected()
          A map of attribute/condition pairs.
 java.util.Map<java.lang.String,AttributeValue> getKey()
          A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
 java.lang.String getReturnConsumedCapacity()
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 java.lang.String getReturnItemCollectionMetrics()
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 java.lang.String getReturnValues()
          Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
 java.lang.String getTableName()
          The name of the table from which to delete the item.
 int hashCode()
           
 void setConditionalOperator(ConditionalOperator conditionalOperator)
          A logical operator to apply to the conditions in the Expected map:
 void setConditionalOperator(java.lang.String conditionalOperator)
          A logical operator to apply to the conditions in the Expected map:
 void setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
          A map of attribute/condition pairs.
 void setKey(java.util.Map.Entry<java.lang.String,AttributeValue> hashKey, java.util.Map.Entry<java.lang.String,AttributeValue> rangeKey)
          A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
 void setKey(java.util.Map<java.lang.String,AttributeValue> key)
          A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
 void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 void setReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 void setReturnValues(ReturnValue returnValues)
          Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
 void setReturnValues(java.lang.String returnValues)
          Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
 void setTableName(java.lang.String tableName)
          The name of the table from which to delete the item.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
          A logical operator to apply to the conditions in the Expected map:
 DeleteItemRequest withConditionalOperator(java.lang.String conditionalOperator)
          A logical operator to apply to the conditions in the Expected map:
 DeleteItemRequest withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
          A map of attribute/condition pairs.
 DeleteItemRequest withKey(java.util.Map.Entry<java.lang.String,AttributeValue> hashKey, java.util.Map.Entry<java.lang.String,AttributeValue> rangeKey)
          A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
 DeleteItemRequest withKey(java.util.Map<java.lang.String,AttributeValue> key)
          A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
 DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 DeleteItemRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
          If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
 DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 DeleteItemRequest withReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
          If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
 DeleteItemRequest withReturnValues(ReturnValue returnValues)
          Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
 DeleteItemRequest withReturnValues(java.lang.String returnValues)
          Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
 DeleteItemRequest withTableName(java.lang.String tableName)
          The name of the table from which to delete the item.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DeleteItemRequest

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

DeleteItemRequest

public DeleteItemRequest(java.lang.String tableName,
                         java.util.Map<java.lang.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.

DeleteItemRequest

public DeleteItemRequest(java.lang.String tableName,
                         java.util.Map<java.lang.String,AttributeValue> key,
                         java.lang.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.
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 is the default for ReturnValues.)

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

DeleteItemRequest

public DeleteItemRequest(java.lang.String tableName,
                         java.util.Map<java.lang.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.
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 is the default for ReturnValues.)

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

Method Detail

getTableName

public java.lang.String getTableName()
The name of the table from which to delete the item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

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

setTableName

public void setTableName(java.lang.String tableName)
The name of the table from which to delete the item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

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

withTableName

public DeleteItemRequest withTableName(java.lang.String tableName)
The name of the table from which to delete the item.

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

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:
tableName - The name of the table from which to delete the item.
Returns:
A reference to this updated object so that method calls can be chained together.

getKey

public java.util.Map<java.lang.String,AttributeValue> getKey()
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

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

setKey

public void setKey(java.util.Map<java.lang.String,AttributeValue> key)
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

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

withKey

public DeleteItemRequest withKey(java.util.Map<java.lang.String,AttributeValue> key)
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

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

Parameters:
key - A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
Returns:
A reference to this updated object so that method calls can be chained together.

setKey

public void setKey(java.util.Map.Entry<java.lang.String,AttributeValue> hashKey,
                   java.util.Map.Entry<java.lang.String,AttributeValue> rangeKey)
            throws java.lang.IllegalArgumentException
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

This method accepts the hashKey, rangeKey of Key as java.util.Map.Entry objects.

Parameters:
hashKey - Primary hash key.
rangeKey - Primary range key. (null if it a hash-only table)
Throws:
java.lang.IllegalArgumentException

withKey

public DeleteItemRequest withKey(java.util.Map.Entry<java.lang.String,AttributeValue> hashKey,
                                 java.util.Map.Entry<java.lang.String,AttributeValue> rangeKey)
                          throws java.lang.IllegalArgumentException
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

This method accepts the hashKey, rangeKey of Key as java.util.Map.Entry objects.

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

Parameters:
hashKey - Primary hash key.
rangeKey - Primary range key. (null if it a hash-only table)
Throws:
java.lang.IllegalArgumentException

addKeyEntry

public DeleteItemRequest addKeyEntry(java.lang.String key,
                                     AttributeValue value)
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

The method adds a new key-value pair into Key parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:
key - The key of the entry to be added into Key.
value - The corresponding value of the entry to be added into Key.

clearKeyEntries

public DeleteItemRequest clearKeyEntries()
Removes all the entries added into Key.

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

getExpected

public java.util.Map<java.lang.String,ExpectedAttributeValue> getExpected()
A map of attribute/condition pairs. This is the conditional block for the DeleteItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

Returns:
A map of attribute/condition pairs. This is the conditional block for the DeleteItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

  • AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

    For type Number, value comparisons are numeric.

    String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

    For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

  • ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.

    The following comparison operators are available:

    EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

    The following are descriptions of each comparison operator.

    • EQ : Equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

    • NE : Not equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

    • LE : Less than or equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • LT : Less than.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • GE : Greater than or equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • GT : Greater than.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • NOT_NULL : The attribute exists.

    • NULL : The attribute does not exist.

    • CONTAINS : checks for a subsequence, or value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).

    • NOT_CONTAINS : checks for absence of a subsequence, or absence of a value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).

    • BEGINS_WITH : checks for a prefix.

      AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

    • IN : checks for exact matches.

      AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.

    • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

      AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

  • Value - A value for DynamoDB to compare with an attribute.

  • Exists - Causes DynamoDB to evaluate the value vefore attempting the conditional operation:

    • If Exists is true, DynamoDB will check to see if that attribute??? value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.

    • If Exists is false, DynamoDB assumes that the attribute value does??? not exist in the table. If in fact the value does not exist, then the??? assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.???

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

setExpected

public void setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs. This is the conditional block for the DeleteItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

Parameters:
expected - A map of attribute/condition pairs. This is the conditional block for the DeleteItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

  • AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

    For type Number, value comparisons are numeric.

    String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

    For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

  • ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.

    The following comparison operators are available:

    EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

    The following are descriptions of each comparison operator.

    • EQ : Equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

    • NE : Not equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

    • LE : Less than or equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • LT : Less than.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • GE : Greater than or equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • GT : Greater than.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • NOT_NULL : The attribute exists.

    • NULL : The attribute does not exist.

    • CONTAINS : checks for a subsequence, or value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).

    • NOT_CONTAINS : checks for absence of a subsequence, or absence of a value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).

    • BEGINS_WITH : checks for a prefix.

      AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

    • IN : checks for exact matches.

      AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.

    • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

      AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

  • Value - A value for DynamoDB to compare with an attribute.

  • Exists - Causes DynamoDB to evaluate the value vefore attempting the conditional operation:

    • If Exists is true, DynamoDB will check to see if that attribute??? value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.

    • If Exists is false, DynamoDB assumes that the attribute value does??? not exist in the table. If in fact the value does not exist, then the??? assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.???

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

withExpected

public DeleteItemRequest withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs. This is the conditional block for the DeleteItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

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

Parameters:
expected - A map of attribute/condition pairs. This is the conditional block for the DeleteItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

  • AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

    For type Number, value comparisons are numeric.

    String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

    For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

  • ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.

    The following comparison operators are available:

    EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

    The following are descriptions of each comparison operator.

    • EQ : Equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

    • NE : Not equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

    • LE : Less than or equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • LT : Less than.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • GE : Greater than or equal.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • GT : Greater than.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

    • NOT_NULL : The attribute exists.

    • NULL : The attribute does not exist.

    • CONTAINS : checks for a subsequence, or value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).

    • NOT_CONTAINS : checks for absence of a subsequence, or absence of a value in a set.

      AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).

    • BEGINS_WITH : checks for a prefix.

      AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

    • IN : checks for exact matches.

      AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.

    • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

      AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

  • Value - A value for DynamoDB to compare with an attribute.

  • Exists - Causes DynamoDB to evaluate the value vefore attempting the conditional operation:

    • If Exists is true, DynamoDB will check to see if that attribute??? value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.

    • If Exists is false, DynamoDB assumes that the attribute value does??? not exist in the table. If in fact the value does not exist, then the??? assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.???

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

Returns:
A reference to this updated object so that method calls can be chained together.

addExpectedEntry

public DeleteItemRequest addExpectedEntry(java.lang.String key,
                                          ExpectedAttributeValue value)
A map of attribute/condition pairs. This is the conditional block for the DeleteItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:

For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

Even though DynamoDB continues to accept the Value and Exists parameters, they are now deprecated. We recommend that you use AttributeValueList and ComparisonOperator instead, since they allow you to constuct a much wider range of conditions.

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. If you attempt to use both sets of parameters at once, DynamoDB will throw a ValidationException.

The method adds a new key-value pair into Expected parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:
key - The key of the entry to be added into Expected.
value - The corresponding value of the entry to be added into Expected.

clearExpectedEntries

public DeleteItemRequest clearExpectedEntries()
Removes all the entries added into Expected.

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

getConditionalOperator

public java.lang.String getConditionalOperator()
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

Constraints:
Allowed Values: AND, OR

Returns:
A logical operator to apply to the conditions in the Expected map:

  • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

  • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

See Also:
ConditionalOperator

setConditionalOperator

public void setConditionalOperator(java.lang.String conditionalOperator)
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

Constraints:
Allowed Values: AND, OR

Parameters:
conditionalOperator - A logical operator to apply to the conditions in the Expected map:

  • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

  • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

See Also:
ConditionalOperator

withConditionalOperator

public DeleteItemRequest withConditionalOperator(java.lang.String conditionalOperator)
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

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

Constraints:
Allowed Values: AND, OR

Parameters:
conditionalOperator - A logical operator to apply to the conditions in the Expected map:

  • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

  • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ConditionalOperator

setConditionalOperator

public void setConditionalOperator(ConditionalOperator conditionalOperator)
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

Constraints:
Allowed Values: AND, OR

Parameters:
conditionalOperator - A logical operator to apply to the conditions in the Expected map:

  • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

  • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

See Also:
ConditionalOperator

withConditionalOperator

public DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

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

Constraints:
Allowed Values: AND, OR

Parameters:
conditionalOperator - A logical operator to apply to the conditions in the Expected map:

  • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

  • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ConditionalOperator

getReturnValues

public java.lang.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:

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

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 is the default for ReturnValues.)

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

See Also:
ReturnValue

setReturnValues

public void setReturnValues(java.lang.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:

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

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 is the default for ReturnValues.)

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

See Also:
ReturnValue

withReturnValues

public DeleteItemRequest withReturnValues(java.lang.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:

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

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

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 is the default for ReturnValues.)

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

Returns:
A reference to this updated 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:

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

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 is the default for ReturnValues.)

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

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:

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

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

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 is the default for ReturnValues.)

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

Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnValue

getReturnConsumedCapacity

public java.lang.String getReturnConsumedCapacity()
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Returns:
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
See Also:
ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:
returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
See Also:
ReturnConsumedCapacity

withReturnConsumedCapacity

public DeleteItemRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

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

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:
returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:
returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
See Also:
ReturnConsumedCapacity

withReturnConsumedCapacity

public DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

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

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:
returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnConsumedCapacity

getReturnItemCollectionMetrics

public java.lang.String getReturnItemCollectionMetrics()
If set to SIZE, 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.

Constraints:
Allowed Values: SIZE, NONE

Returns:
If set to SIZE, 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

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
If set to SIZE, 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.

Constraints:
Allowed Values: SIZE, NONE

Parameters:
returnItemCollectionMetrics - If set to SIZE, 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(java.lang.String returnItemCollectionMetrics)
If set to SIZE, 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SIZE, NONE

Parameters:
returnItemCollectionMetrics - If set to SIZE, 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:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnItemCollectionMetrics

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
If set to SIZE, 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.

Constraints:
Allowed Values: SIZE, NONE

Parameters:
returnItemCollectionMetrics - If set to SIZE, 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)
If set to SIZE, 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SIZE, NONE

Parameters:
returnItemCollectionMetrics - If set to SIZE, 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:
A reference to this updated object so that method calls can be chained together.
See Also:
ReturnItemCollectionMetrics

toString

public java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.