|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.dynamodbv2.model.DeleteItemRequest
public class DeleteItemRequest
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, Amazon DynamoDB performs the delete. Otherwise, the item is not deleted.
AmazonDynamoDB.deleteItem(DeleteItemRequest)
,
Serialized FormConstructor 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. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
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()
Determines whether to include consumed capacity information in the output. |
java.lang.String |
getReturnItemCollectionMetrics()
Indicates whether to return statistics about item collections, if any, that were modified during the operation. |
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 |
setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs. |
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)
Determines whether to include consumed capacity information in the output. |
void |
setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines whether to include consumed capacity information in the output. |
void |
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Indicates whether to return statistics about item collections, if any, that were modified during the operation. |
void |
setReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
Indicates whether to return statistics about item collections, if any, that were modified during the operation. |
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 |
withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs. |
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)
Determines whether to include consumed capacity information in the output. |
DeleteItemRequest |
withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines whether to include consumed capacity information in the output. |
DeleteItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Indicates whether to return statistics about item collections, if any, that were modified during the operation. |
DeleteItemRequest |
withReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
Indicates whether to return statistics about item collections, if any, that were modified during the operation. |
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, getRequestClientOptions, getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DeleteItemRequest()
public DeleteItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key)
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.Method Detail |
---|
public java.lang.String getTableName()
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
public void setTableName(java.lang.String tableName)
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table from which to delete the item.public DeleteItemRequest withTableName(java.lang.String tableName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table from which to delete the item.
public java.util.Map<java.lang.String,AttributeValue> getKey()
public void setKey(java.util.Map<java.lang.String,AttributeValue> key)
key
- A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.public DeleteItemRequest withKey(java.util.Map<java.lang.String,AttributeValue> key)
Returns a reference to this object so that method calls can be chained together.
key
- A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
public java.util.Map<java.lang.String,ExpectedAttributeValue> getExpected()
Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value-the attribute value for Amazon DynamoDB to check.
Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon 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 operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value-the attribute value for Amazon DynamoDB to check.
Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon 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 operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
public void setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value-the attribute value for Amazon DynamoDB to check.
Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon 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 operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
expected
- A map of attribute/condition pairs. This is the conditional block for
the DeleteItemoperation. All the conditions must be met for the
operation to succeed. Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value-the attribute value for Amazon DynamoDB to check.
Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon 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 operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
public DeleteItemRequest withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value-the attribute value for Amazon DynamoDB to check.
Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon 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 operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
Returns a reference to this object so that method calls can be chained together.
expected
- A map of attribute/condition pairs. This is the conditional block for
the DeleteItemoperation. All the conditions must be met for the
operation to succeed. Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value-the attribute value for Amazon DynamoDB to check.
Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon 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 operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
public java.lang.String getReturnValues()
NONE
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
NONE
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
ReturnValue
public void setReturnValues(java.lang.String returnValues)
NONE
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
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
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
ReturnValue
public DeleteItemRequest withReturnValues(java.lang.String returnValues)
NONE
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
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
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
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
ReturnValue
public void setReturnValues(ReturnValue returnValues)
NONE
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
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
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
ReturnValue
public DeleteItemRequest withReturnValues(ReturnValue returnValues)
NONE
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
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
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
-(default) If
ReturnValues is not specified, or if its value is
NONE
, then nothing is returned.
ALL_OLD
-The content of the old item is returned.
ReturnValue
public java.lang.String getReturnConsumedCapacity()
TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.
Constraints:
Allowed Values: TOTAL, NONE
TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.ReturnConsumedCapacity
public void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity
- Determines whether to include consumed capacity information in the
output. If this is set to TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.ReturnConsumedCapacity
public DeleteItemRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity
- Determines whether to include consumed capacity information in the
output. If this is set to TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.
ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity
- Determines whether to include consumed capacity information in the
output. If this is set to TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.ReturnConsumedCapacity
public DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity
- Determines whether to include consumed capacity information in the
output. If this is set to TOTAL
, then this information is
shown in the output; otherwise, the consumed capacity information is
not shown.
ReturnConsumedCapacity
public java.lang.String getReturnItemCollectionMetrics()
NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.
Constraints:
Allowed Values: SIZE, NONE
NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.ReturnItemCollectionMetrics
public void setReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.
Constraints:
Allowed Values: SIZE, NONE
returnItemCollectionMetrics
- Indicates whether to return statistics about item collections, if any,
that were modified during the operation. The default for
ReturnItemCollectionMetrics is NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.ReturnItemCollectionMetrics
public DeleteItemRequest withReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIZE, NONE
returnItemCollectionMetrics
- Indicates whether to return statistics about item collections, if any,
that were modified during the operation. The default for
ReturnItemCollectionMetrics is NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.
ReturnItemCollectionMetrics
public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.
Constraints:
Allowed Values: SIZE, NONE
returnItemCollectionMetrics
- Indicates whether to return statistics about item collections, if any,
that were modified during the operation. The default for
ReturnItemCollectionMetrics is NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.ReturnItemCollectionMetrics
public DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIZE, NONE
returnItemCollectionMetrics
- Indicates whether to return statistics about item collections, if any,
that were modified during the operation. The default for
ReturnItemCollectionMetrics is NONE
, meaning that
no statistics will be returned. To obtain the statistics, set
ReturnItemCollectionMetrics to SIZE
.
ReturnItemCollectionMetrics
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |