public class DeleteItemRequest extends AmazonWebServiceRequest implements java.io.Serializable
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 deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
Constructor and Description |
---|
DeleteItemRequest()
Default constructor for DeleteItemRequest object.
|
DeleteItemRequest(java.lang.String tableName,
java.util.Map<java.lang.String,AttributeValue> key)
Constructs a new DeleteItemRequest object.
|
DeleteItemRequest(java.lang.String tableName,
java.util.Map<java.lang.String,AttributeValue> key,
ReturnValue returnValues)
Constructs a new DeleteItemRequest object.
|
DeleteItemRequest(java.lang.String tableName,
java.util.Map<java.lang.String,AttributeValue> key,
java.lang.String returnValues)
Constructs a new DeleteItemRequest object.
|
Modifier and Type | Method and Description |
---|---|
DeleteItemRequest |
addExpectedEntry(java.lang.String key,
ExpectedAttributeValue value)
This is a legacy parameter.
|
DeleteItemRequest |
addExpressionAttributeNamesEntry(java.lang.String key,
java.lang.String value)
One or more substitution tokens for attribute names in an expression.
|
DeleteItemRequest |
addExpressionAttributeValuesEntry(java.lang.String key,
AttributeValue value)
One or more values that can be substituted in an expression.
|
DeleteItemRequest |
addKeyEntry(java.lang.String key,
AttributeValue value)
A map of attribute names to
AttributeValue objects,
representing the primary key of the item to delete. |
DeleteItemRequest |
clearExpectedEntries()
Removes all the entries added into Expected.
|
DeleteItemRequest |
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.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getConditionalOperator()
This is a legacy parameter.
|
java.lang.String |
getConditionExpression()
A condition that must be satisfied in order for a conditional
DeleteItem to succeed. |
java.util.Map<java.lang.String,ExpectedAttributeValue> |
getExpected()
This is a legacy parameter.
|
java.util.Map<java.lang.String,java.lang.String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
java.util.Map<java.lang.String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
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 the level of detail about provisioned throughput consumption
that is returned in the response:
|
java.lang.String |
getReturnItemCollectionMetrics()
Determines whether item collection metrics are returned.
|
java.lang.String |
getReturnValues()
Use
ReturnValues if you want to get the item attributes as
they appeared before they were deleted. |
java.lang.String |
getTableName()
The name of the table from which to delete the item.
|
int |
hashCode() |
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
void |
setConditionalOperator(java.lang.String conditionalOperator)
This is a legacy parameter.
|
void |
setConditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem to succeed. |
void |
setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
This is a legacy parameter.
|
void |
setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
void |
setExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
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 the level of detail about provisioned throughput consumption
that is returned in the response:
|
void |
setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
void |
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
void |
setReturnItemCollectionMetrics(java.lang.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(java.lang.String returnValues)
Use
ReturnValues if you want to get the item attributes as
they appeared before they were deleted. |
void |
setTableName(java.lang.String tableName)
The name of the table from which to delete the item.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DeleteItemRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
DeleteItemRequest |
withConditionalOperator(java.lang.String conditionalOperator)
This is a legacy parameter.
|
DeleteItemRequest |
withConditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem to succeed. |
DeleteItemRequest |
withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
This is a legacy parameter.
|
DeleteItemRequest |
withExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
DeleteItemRequest |
withExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
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 the level of detail about provisioned throughput consumption
that is returned in the response:
|
DeleteItemRequest |
withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
DeleteItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
DeleteItemRequest |
withReturnItemCollectionMetrics(java.lang.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(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.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
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.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public DeleteItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key, java.lang.String returnValues)
tableName
- The name of the table from which to delete the item.
key
-
A map of attribute names to AttributeValue
objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
returnValues
-
Use ReturnValues
if you want to get the item
attributes as they appeared before they were deleted. For
DeleteItem
, the valid values are:
NONE
- If ReturnValues
is not
specified, or if its value is NONE
, then nothing
is returned. (This setting is the default for
ReturnValues
.)
ALL_OLD
- The content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, DeleteItem
does not
recognize any values other than NONE
or
ALL_OLD
.
public DeleteItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> key, ReturnValue returnValues)
tableName
- The name of the table from which to delete the item.
key
-
A map of attribute names to AttributeValue
objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
returnValues
-
Use ReturnValues
if you want to get the item
attributes as they appeared before they were deleted. For
DeleteItem
, the valid values are:
NONE
- If ReturnValues
is not
specified, or if its value is NONE
, then nothing
is returned. (This setting is the default for
ReturnValues
.)
ALL_OLD
- The content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, DeleteItem
does not
recognize any values other than NONE
or
ALL_OLD
.
public java.lang.String getTableName()
The name of the table from which to delete the item.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
The name of the table from which to delete the item.
public void setTableName(java.lang.String tableName)
The name of the table from which to delete the item.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table from which to delete the item.
public DeleteItemRequest withTableName(java.lang.String tableName)
The name of the table from which to delete the item.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table from which to delete the item.
public java.util.Map<java.lang.String,AttributeValue> getKey()
A map of attribute names to AttributeValue
objects,
representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
A map of attribute names to AttributeValue
objects,
representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public void setKey(java.util.Map<java.lang.String,AttributeValue> key)
A map of attribute names to AttributeValue
objects,
representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
key
-
A map of attribute names to AttributeValue
objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public DeleteItemRequest withKey(java.util.Map<java.lang.String,AttributeValue> key)
A map of attribute names to AttributeValue
objects,
representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
Returns a 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.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public DeleteItemRequest addKeyEntry(java.lang.String key, AttributeValue value)
A map of attribute names to AttributeValue
objects,
representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
The method adds a new key-value pair into Key parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Key.value
- The corresponding value of the entry to be added into Key.public DeleteItemRequest clearKeyEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.Map<java.lang.String,ExpectedAttributeValue> getExpected()
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see Expected in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
public void setExpected(java.util.Map<java.lang.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(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see Expected in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
expected
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see Expected in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest addExpectedEntry(java.lang.String key, ExpectedAttributeValue value)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see Expected in the Amazon DynamoDB Developer Guide.
The method adds a new key-value pair into Expected parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Expected.value
- The corresponding value of the entry to be added into
Expected.public DeleteItemRequest clearExpectedEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String getConditionalOperator()
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: AND, OR
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public void setConditionalOperator(java.lang.String conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: AND, OR
conditionalOperator
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public DeleteItemRequest withConditionalOperator(java.lang.String conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: AND, OR
conditionalOperator
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public java.lang.String getReturnValues()
Use ReturnValues
if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem
, the
valid values are:
NONE
- If ReturnValues
is not specified, or if
its value is NONE
, then nothing is returned. (This setting
is the default for ReturnValues
.)
ALL_OLD
- The content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, DeleteItem
does not recognize any
values other than NONE
or ALL_OLD
.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
Use ReturnValues
if you want to get the item
attributes as they appeared before they were deleted. For
DeleteItem
, the valid values are:
NONE
- If ReturnValues
is not
specified, or if its value is NONE
, then nothing is
returned. (This setting is the default for
ReturnValues
.)
ALL_OLD
- The content of the old item is returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, DeleteItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public void setReturnValues(java.lang.String returnValues)
Use ReturnValues
if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem
, the
valid values are:
NONE
- If ReturnValues
is not specified, or if
its value is NONE
, then nothing is returned. (This setting
is the default for ReturnValues
.)
ALL_OLD
- The content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, DeleteItem
does not recognize any
values other than NONE
or ALL_OLD
.
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 setting is the default for
ReturnValues
.)
ALL_OLD
- The content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, DeleteItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public DeleteItemRequest withReturnValues(java.lang.String returnValues)
Use ReturnValues
if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem
, the
valid values are:
NONE
- If ReturnValues
is not specified, or if
its value is NONE
, then nothing is returned. (This setting
is the default for ReturnValues
.)
ALL_OLD
- The content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, DeleteItem
does not recognize any
values other than NONE
or ALL_OLD
.
Returns 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 setting is the default for
ReturnValues
.)
ALL_OLD
- The content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, DeleteItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public void setReturnValues(ReturnValue returnValues)
Use ReturnValues
if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem
, the
valid values are:
NONE
- If ReturnValues
is not specified, or if
its value is NONE
, then nothing is returned. (This setting
is the default for ReturnValues
.)
ALL_OLD
- The content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, DeleteItem
does not recognize any
values other than NONE
or ALL_OLD
.
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 setting is the default for
ReturnValues
.)
ALL_OLD
- The content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, DeleteItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public DeleteItemRequest withReturnValues(ReturnValue returnValues)
Use ReturnValues
if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem
, the
valid values are:
NONE
- If ReturnValues
is not specified, or if
its value is NONE
, then nothing is returned. (This setting
is the default for ReturnValues
.)
ALL_OLD
- The content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, DeleteItem
does not recognize any
values other than NONE
or ALL_OLD
.
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 setting is the default for
ReturnValues
.)
ALL_OLD
- The content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, DeleteItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public java.lang.String getReturnConsumedCapacity()
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index
that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In
these cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are
included in the response.
ReturnConsumedCapacity
public void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary
index that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all.
In these cases, specifying INDEXES
will only
return ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details
are included in the response.
ReturnConsumedCapacity
public DeleteItemRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary
index that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all.
In these cases, specifying INDEXES
will only
return ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details
are included in the response.
ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary
index that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all.
In these cases, specifying INDEXES
will only
return ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details
are included in the response.
ReturnConsumedCapacity
public DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary
index that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all.
In these cases, specifying INDEXES
will only
return ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details
are included in the response.
ReturnConsumedCapacity
public java.lang.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.
Constraints:
Allowed Values: SIZE, NONE
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
public void setReturnItemCollectionMetrics(java.lang.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.
Constraints:
Allowed Values: SIZE, NONE
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
public DeleteItemRequest withReturnItemCollectionMetrics(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIZE, NONE
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
public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
Constraints:
Allowed Values: SIZE, NONE
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
public DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIZE, NONE
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
public java.lang.String getConditionExpression()
A condition that must be satisfied in order for a conditional
DeleteItem
to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
A condition that must be satisfied in order for a conditional
DeleteItem
to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public void setConditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem
to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
conditionExpression
-
A condition that must be satisfied in order for a conditional
DeleteItem
to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest withConditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem
to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
conditionExpression
-
A condition that must be satisfied in order for a conditional
DeleteItem
to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public java.util.Map<java.lang.String,java.lang.String> getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression. The
following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot
be used directly in an expression. (For the complete list of reserved
words, see Reserved Words in the Amazon DynamoDB Developer Guide). To
work around this, you could specify the following for
ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
One or more substitution tokens for attribute names in an
expression. The following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it
cannot be used directly in an expression. (For the complete list
of reserved words, see Reserved Words in the Amazon DynamoDB Developer
Guide). To work around this, you could specify the following
for ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The
following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot
be used directly in an expression. (For the complete list of reserved
words, see Reserved Words in the Amazon DynamoDB Developer Guide). To
work around this, you could specify the following for
ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames
-
One or more substitution tokens for attribute names in an
expression. The following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so
it cannot be used directly in an expression. (For the complete
list of reserved words, see Reserved Words in the Amazon DynamoDB Developer
Guide). To work around this, you could specify the
following for ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest withExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The
following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot
be used directly in an expression. (For the complete list of reserved
words, see Reserved Words in the Amazon DynamoDB Developer Guide). To
work around this, you could specify the following for
ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
expressionAttributeNames
-
One or more substitution tokens for attribute names in an
expression. The following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so
it cannot be used directly in an expression. (For the complete
list of reserved words, see Reserved Words in the Amazon DynamoDB Developer
Guide). To work around this, you could specify the
following for ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest addExpressionAttributeNamesEntry(java.lang.String key, java.lang.String value)
One or more substitution tokens for attribute names in an expression. The
following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot
be used directly in an expression. (For the complete list of reserved
words, see Reserved Words in the Amazon DynamoDB Developer Guide). To
work around this, you could specify the following for
ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
The method adds a new key-value pair into ExpressionAttributeNames parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into
ExpressionAttributeNames.value
- The corresponding value of the entry to be added into
ExpressionAttributeNames.public DeleteItemRequest clearExpressionAttributeNamesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.Map<java.lang.String,AttributeValue> getExpressionAttributeValues()
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as
follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify
ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as
follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify
ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest withExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as
follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify
ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest addExpressionAttributeValuesEntry(java.lang.String key, AttributeValue value)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as
follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
The method adds a new key-value pair into ExpressionAttributeValues parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into
ExpressionAttributeValues.value
- The corresponding value of the entry to be added into
ExpressionAttributeValues.public DeleteItemRequest clearExpressionAttributeValuesEntries()
Returns a reference to this object so that method calls can be chained together.
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
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.