|
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(String tableName,
Map<String,AttributeValue> key)
Constructs a new DeleteItemRequest object. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
Map<String,ExpectedAttributeValue> |
getExpected()
A map of attribute/condition pairs. |
Map<String,AttributeValue> |
getKey()
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete. |
String |
getReturnConsumedCapacity()
If set to TOTAL , ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
String |
getReturnItemCollectionMetrics()
If set to SIZE , statistics about item collections, if
any, that were modified during the operation are returned in the
response. |
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 |
setExpected(Map<String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs. |
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)
If set to TOTAL , ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
void |
setReturnConsumedCapacity(String returnConsumedCapacity)
If set to TOTAL , ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
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(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(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 |
withExpected(Map<String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs. |
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)
If set to TOTAL , ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
DeleteItemRequest |
withReturnConsumedCapacity(String returnConsumedCapacity)
If set to TOTAL , ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
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(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(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 |
---|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DeleteItemRequest()
public DeleteItemRequest(String tableName, Map<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 String getTableName()
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
public void setTableName(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(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 Map<String,AttributeValue> getKey()
public void setKey(Map<String,AttributeValue> key)
key
- A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.public DeleteItemRequest withKey(Map<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 Map<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(Map<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(Map<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 String getReturnValues()
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.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
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.
ReturnValue
public void setReturnValues(String returnValues)
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.
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
- 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.
ReturnValue
public DeleteItemRequest withReturnValues(String returnValues)
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 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
- 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.
ReturnValue
public void setReturnValues(ReturnValue returnValues)
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.
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
- 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.
ReturnValue
public DeleteItemRequest withReturnValues(ReturnValue returnValues)
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 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
- 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.
ReturnValue
public String getReturnConsumedCapacity()
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.ReturnConsumedCapacity
public void setReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity
- If set to TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.ReturnConsumedCapacity
public DeleteItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity
- If set to TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity
- If set to TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.ReturnConsumedCapacity
public DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity
- If set to TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
ReturnConsumedCapacity
public String getReturnItemCollectionMetrics()
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
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..ReturnItemCollectionMetrics
public void setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
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
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..ReturnItemCollectionMetrics
public DeleteItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
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
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..
ReturnItemCollectionMetrics
public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
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
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..ReturnItemCollectionMetrics
public DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
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
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..
ReturnItemCollectionMetrics
public String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |