@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DeleteItemRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a DeleteItem operation.
NOOP| Constructor and Description |
|---|
DeleteItemRequest()
Default constructor for DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key)
Constructs a new DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key,
ReturnValue returnValues)
Constructs a new DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key,
String returnValues)
Constructs a new DeleteItemRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
DeleteItemRequest |
addExpectedEntry(String key,
ExpectedAttributeValue value)
Add a single Expected entry
|
DeleteItemRequest |
addExpressionAttributeNamesEntry(String key,
String value)
Add a single ExpressionAttributeNames entry
|
DeleteItemRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value)
Add a single ExpressionAttributeValues entry
|
DeleteItemRequest |
addKeyEntry(String key,
AttributeValue value)
Add a single Key entry
|
DeleteItemRequest |
clearExpectedEntries()
Removes all the entries added into Expected.
|
DeleteItemRequest |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
DeleteItemRequest |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
DeleteItemRequest |
clearKeyEntries()
Removes all the entries added into Key.
|
DeleteItemRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getConditionalOperator()
This is a legacy parameter.
|
String |
getConditionExpression()
A condition that must be satisfied in order for a conditional
DeleteItem to succeed. |
Map<String,ExpectedAttributeValue> |
getExpected()
This is a legacy parameter.
|
Map<String,String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
Map<String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
Map<String,AttributeValue> |
getKey()
A map of attribute names to
AttributeValue objects, representing the primary key of the item to
delete. |
String |
getReturnConsumedCapacity() |
String |
getReturnItemCollectionMetrics()
Determines whether item collection metrics are returned.
|
String |
getReturnValues()
Use
ReturnValues if you want to get the item attributes as they appeared before they were deleted. |
String |
getReturnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for a
DeleteItem operation that failed a
condition check. |
String |
getTableName()
The name of the table from which to delete the item.
|
int |
hashCode() |
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
void |
setConditionalOperator(String conditionalOperator)
This is a legacy parameter.
|
void |
setConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem to succeed. |
void |
setExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter.
|
void |
setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
void |
setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
Set the hash and range key attributes of the item.
|
void |
setKey(Map<String,AttributeValue> key)
A map of attribute names to
AttributeValue objects, representing the primary key of the item to
delete. |
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
void |
setReturnConsumedCapacity(String returnConsumedCapacity) |
void |
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
void |
setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
void |
setReturnValues(ReturnValue returnValues)
Use
ReturnValues if you want to get the item attributes as they appeared before they were deleted. |
void |
setReturnValues(String returnValues)
Use
ReturnValues if you want to get the item attributes as they appeared before they were deleted. |
void |
setReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a
DeleteItem operation that failed a
condition check. |
void |
setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a
DeleteItem operation that failed a
condition check. |
void |
setTableName(String tableName)
The name of the table from which to delete the item.
|
String |
toString()
Returns a string representation of this object.
|
DeleteItemRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
DeleteItemRequest |
withConditionalOperator(String conditionalOperator)
This is a legacy parameter.
|
DeleteItemRequest |
withConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem to succeed. |
DeleteItemRequest |
withExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter.
|
DeleteItemRequest |
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
DeleteItemRequest |
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
DeleteItemRequest |
withKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
Set the hash and range key attributes of the item.
|
DeleteItemRequest |
withKey(Map<String,AttributeValue> key)
A map of attribute names to
AttributeValue objects, representing the primary key of the item to
delete. |
DeleteItemRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
DeleteItemRequest |
withReturnConsumedCapacity(String returnConsumedCapacity) |
DeleteItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
DeleteItemRequest |
withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
DeleteItemRequest |
withReturnValues(ReturnValue returnValues)
Use
ReturnValues if you want to get the item attributes as they appeared before they were deleted. |
DeleteItemRequest |
withReturnValues(String returnValues)
Use
ReturnValues if you want to get the item attributes as they appeared before they were deleted. |
DeleteItemRequest |
withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a
DeleteItem operation that failed a
condition check. |
DeleteItemRequest |
withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a
DeleteItem operation that failed a
condition check. |
DeleteItemRequest |
withTableName(String tableName)
The name of the table from which to delete the item.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic DeleteItemRequest()
public DeleteItemRequest(String tableName, Map<String,AttributeValue> key)
tableName - The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.key - A map of attribute names to AttributeValue objects, representing the primary key of the item
to delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public DeleteItemRequest(String tableName, Map<String,AttributeValue> key, String returnValues)
tableName - The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.key - A map of attribute names to AttributeValue objects, representing the primary key of the item
to delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were
deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE,
then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however,
DeleteItem does not recognize any values other than NONE or ALL_OLD
.
public DeleteItemRequest(String tableName, Map<String,AttributeValue> key, ReturnValue returnValues)
tableName - The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.key - A map of attribute names to AttributeValue objects, representing the primary key of the item
to delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were
deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE,
then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however,
DeleteItem does not recognize any values other than NONE or ALL_OLD
.
public void setTableName(String tableName)
The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
tableName - The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.public String getTableName()
The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
public DeleteItemRequest withTableName(String tableName)
The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
tableName - The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.public Map<String,AttributeValue> getKey()
A map of attribute names to AttributeValue objects, representing the primary key of the item to
delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
AttributeValue objects, representing the primary key of the item
to delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public void setKey(Map<String,AttributeValue> key)
A map of attribute names to AttributeValue objects, representing the primary key of the item to
delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
key - A map of attribute names to AttributeValue objects, representing the primary key of the item
to delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public DeleteItemRequest withKey(Map<String,AttributeValue> key)
A map of attribute names to AttributeValue objects, representing the primary key of the item to
delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
key - A map of attribute names to AttributeValue objects, representing the primary key of the item
to delete.
For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public DeleteItemRequest addKeyEntry(String key, AttributeValue value)
public DeleteItemRequest clearKeyEntries()
public Map<String,ExpectedAttributeValue> getExpected()
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public void setExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
expected - This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public DeleteItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
expected - This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public DeleteItemRequest addExpectedEntry(String key, ExpectedAttributeValue value)
public DeleteItemRequest clearExpectedEntries()
public void setConditionalOperator(String conditionalOperator)
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic String getConditionalOperator()
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic DeleteItemRequest withConditionalOperator(String conditionalOperator)
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic void setReturnValues(String returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then
nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem
does not recognize any values other than NONE or ALL_OLD.
returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were
deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE,
then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however,
DeleteItem does not recognize any values other than NONE or ALL_OLD
.
ReturnValuepublic String getReturnValues()
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then
nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem
does not recognize any values other than NONE or ALL_OLD.
ReturnValues if you want to get the item attributes as they appeared before they were
deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE,
then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however,
DeleteItem does not recognize any values other than NONE or
ALL_OLD.
ReturnValuepublic DeleteItemRequest withReturnValues(String returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then
nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem
does not recognize any values other than NONE or ALL_OLD.
returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were
deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE,
then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however,
DeleteItem does not recognize any values other than NONE or ALL_OLD
.
ReturnValuepublic void setReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then
nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem
does not recognize any values other than NONE or ALL_OLD.
returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were
deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE,
then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however,
DeleteItem does not recognize any values other than NONE or ALL_OLD
.
ReturnValuepublic DeleteItemRequest withReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then
nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem
does not recognize any values other than NONE or ALL_OLD.
returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were
deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE,
then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues parameter is used by several DynamoDB operations; however,
DeleteItem does not recognize any values other than NONE or ALL_OLD
.
ReturnValuepublic void setReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic String getReturnConsumedCapacity()
ReturnConsumedCapacitypublic DeleteItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic void setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response
includes statistics about item collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics are returned.ReturnItemCollectionMetricspublic String getReturnItemCollectionMetrics()
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
SIZE, the response
includes statistics about item collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics are returned.ReturnItemCollectionMetricspublic DeleteItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response
includes statistics about item collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics are returned.ReturnItemCollectionMetricspublic void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response
includes statistics about item collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics are returned.ReturnItemCollectionMetricspublic DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response
includes statistics about item collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics are returned.ReturnItemCollectionMetricspublic void setConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
conditionExpression - A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public String getConditionExpression()
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
DeleteItem to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest withConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
conditionExpression - A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public Map<String,String> getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an
expression. (For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for
using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression.
(For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for
using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression.
(For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest addExpressionAttributeNamesEntry(String key, String value)
public DeleteItemRequest clearExpressionAttributeNamesEntries()
public Map<String,AttributeValue> getExpressionAttributeValues()
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues - One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues - One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
public DeleteItemRequest clearExpressionAttributeValuesEntries()
public void setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a DeleteItem operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
returnValuesOnConditionCheckFailure - An optional parameter that returns the item attributes for a DeleteItem operation that failed
a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailurepublic String getReturnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for a DeleteItem operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
DeleteItem operation that
failed a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailurepublic DeleteItemRequest withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a DeleteItem operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
returnValuesOnConditionCheckFailure - An optional parameter that returns the item attributes for a DeleteItem operation that failed
a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailurepublic void setReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a DeleteItem operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
returnValuesOnConditionCheckFailure - An optional parameter that returns the item attributes for a DeleteItem operation that failed
a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailurepublic DeleteItemRequest withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a DeleteItem operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
returnValuesOnConditionCheckFailure - An optional parameter that returns the item attributes for a DeleteItem operation that failed
a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailurepublic void setKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.
hashKey - a map entry including the name and value of the primary hash key.rangeKey - a map entry including the name and value of the primary range key, or null if it is a hash-only table.IllegalArgumentExceptionpublic DeleteItemRequest withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.
Returns a reference to this object so that method calls can be chained together.
hashKey - a map entry including the name and value of the primary hash key.rangeKey - a map entry including the name and value of the primary range key, or null if it is a hash-only table.IllegalArgumentExceptionpublic String toString()
toString in class ObjectObject.toString()public DeleteItemRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()