/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.dynamodbv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* Represents the input of a DeleteItem
operation.
*
* The name of the table from which to delete the item. *
*/ private String tableName; /** *
* 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. *
*/ private java.util.Map
* 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 ConditionalOperator in the Amazon DynamoDB Developer Guide.
*
* 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
.
*
* 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.
*
* 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. *
*/ private String conditionExpression; /** *
* 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. *
*/ private java.util.Map* 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. *
*/ private java.util.Map
* 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. *
*/ private String returnValuesOnConditionCheckFailure; /** * Default constructor for DeleteItemRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize the object after creating it. */ public DeleteItemRequest() { } /** * Constructs a new DeleteItemRequest object. Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @param tableName * The name of the table from which to delete the item. * @param key * A map of attribute names toAttributeValue
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, java.util.MapAttributeValue
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.
* @param 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
* .
*
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.
* @param 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
* .
*
* The name of the table from which to delete the item. *
* * @param tableName * The name of the table from which to delete the item. */ public void setTableName(String tableName) { this.tableName = tableName; } /** ** The name of the table from which to delete the item. *
* * @return The name of the table from which to delete the item. */ public String getTableName() { return this.tableName; } /** ** The name of the table from which to delete the item. *
* * @param tableName * The name of the table from which to delete the item. * @return Returns a reference to this object so that method calls can be chained together. */ public DeleteItemRequest withTableName(String tableName) { setTableName(tableName); return this; } /** *
* 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. *
* * @return A map of attribute names toAttributeValue
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 java.util.Map
* A map of attribute names to
* 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.
* 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(java.util.Map
* A map of attribute names to
* 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.
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteItemRequest withKey(java.util.Map
* This is a legacy parameter. Use
* This is a legacy parameter. Use
* This is a legacy parameter. Use
* This is a legacy parameter. Use
* This is a legacy parameter. Use
* This is a legacy parameter. Use
* This is a legacy parameter. Use
* This is a legacy parameter. Use
* Use
*
*
* 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 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 java.util.MapConditionExpression
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(java.util.MapConditionExpression
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteItemRequest withExpected(java.util.MapConditionExpression
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.
* @see ConditionalOperator
*/
public void setConditionalOperator(String conditionalOperator) {
this.conditionalOperator = conditionalOperator;
}
/**
* 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.
* @see ConditionalOperator
*/
public String getConditionalOperator() {
return this.conditionalOperator;
}
/**
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConditionalOperator
*/
public DeleteItemRequest withConditionalOperator(String conditionalOperator) {
setConditionalOperator(conditionalOperator);
return this;
}
/**
* 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.
* @see ConditionalOperator
*/
public void setConditionalOperator(ConditionalOperator conditionalOperator) {
withConditionalOperator(conditionalOperator);
}
/**
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConditionalOperator
*/
public DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator) {
this.conditionalOperator = conditionalOperator.toString();
return this;
}
/**
* 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.
* 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
* .
*
* 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
.
*
* 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
* .
*
* 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
* .
*
* 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
* .
*
* 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.
* @see ReturnItemCollectionMetrics
*/
public void setReturnItemCollectionMetrics(String returnItemCollectionMetrics) {
this.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.
*
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.
* @see ReturnItemCollectionMetrics
*/
public String getReturnItemCollectionMetrics() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnItemCollectionMetrics
*/
public DeleteItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics) {
setReturnItemCollectionMetrics(returnItemCollectionMetrics);
return this;
}
/**
*
* 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.
* @see ReturnItemCollectionMetrics
*/
public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) {
withReturnItemCollectionMetrics(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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnItemCollectionMetrics
*/
public DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) {
this.returnItemCollectionMetrics = returnItemCollectionMetrics.toString();
return this;
}
/**
*
* 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. *
* * @param conditionExpression * A condition that must be satisfied in order for a conditionalDeleteItem
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 void setConditionExpression(String conditionExpression) { this.conditionExpression = 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. *
* * @return A condition that must be satisfied in order for a conditionalDeleteItem
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() { return this.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. *
* * @param conditionExpression * A condition that must be satisfied in order for a conditionalDeleteItem
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. * @return Returns a reference to this object so that method calls can be chained together. */ public DeleteItemRequest withConditionExpression(String conditionExpression) { setConditionExpression(conditionExpression); return this; } /** *
* 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. *
* * @return One or more substitution tokens for attribute names in an expression. The following are some use cases * for usingExpressionAttributeNames
:
* * 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 java.util.Map
* One or more substitution tokens for attribute names in an expression. The following are some use cases for using
*
* 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:
*
*
* 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
*
*
* You could then use this substitution in an expression, as in this example:
*
*
* 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
:
*
*
*
*
* Percentile
* ExpressionAttributeNames
:
*
*
* {"#P":"Percentile"}
*
*
* #P = :val
* 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(java.util.Map
* One or more substitution tokens for attribute names in an expression. The following are some use cases for using
*
* 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:
*
*
* 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
*
*
* You could then use this substitution in an expression, as in this example:
*
*
* 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
:
*
*
*
*
* Percentile
* ExpressionAttributeNames
:
*
*
* {"#P":"Percentile"}
*
*
* #P = :val
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteItemRequest withExpressionAttributeNames(java.util.Map
* 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:
*
*
* You would first need to specify
*
* You could then use these values in an expression, such as this:
*
*
* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
* Available | Backordered | Discontinued
* ExpressionAttributeValues
as follows:
* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
* ProductStatus IN (:avail, :back, :disc)
*
* 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 java.util.Map
* 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:
*
*
* You would first need to specify
*
* You could then use these values in an expression, such as this:
*
*
* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
* Available | Backordered | Discontinued
* ExpressionAttributeValues
as follows:
* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
* ProductStatus IN (:avail, :back, :disc)
*
* 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(java.util.Map
* 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:
*
*
* You would first need to specify
*
* You could then use these values in an expression, such as this:
*
*
* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
* Available | Backordered | Discontinued
* ExpressionAttributeValues
as follows:
* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
* ProductStatus IN (:avail, :back, :disc)
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteItemRequest withExpressionAttributeValues(java.util.Map
* An optional parameter that returns the item attributes for a
* 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.
* 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. * @see ReturnValuesOnConditionCheckFailure */ public void setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) { this.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. *
* * @return An optional parameter that returns the item attributes for aDeleteItem
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. * @see ReturnValuesOnConditionCheckFailure */ public String getReturnValuesOnConditionCheckFailure() { return this.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. *
* * @param returnValuesOnConditionCheckFailure * An optional parameter that returns the item attributes for aDeleteItem
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. * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnValuesOnConditionCheckFailure */ public DeleteItemRequest withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) { setReturnValuesOnConditionCheckFailure(returnValuesOnConditionCheckFailure); return this; } /** *
* 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. *
* * @param returnValuesOnConditionCheckFailure * An optional parameter that returns the item attributes for aDeleteItem
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. * @see ReturnValuesOnConditionCheckFailure */ public void setReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) { withReturnValuesOnConditionCheckFailure(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. *
* * @param returnValuesOnConditionCheckFailure * An optional parameter that returns the item attributes for aDeleteItem
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. * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnValuesOnConditionCheckFailure */ public DeleteItemRequest withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) { this.returnValuesOnConditionCheckFailure = returnValuesOnConditionCheckFailure.toString(); return this; } /** * Set the hash and range key attributes of the item. *
* For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide
* both.
*
* @param hashKey
* a map entry including the name and value of the primary hash key.
* @param rangeKey
* a map entry including the name and value of the primary range key, or null if it is a hash-only table.
*/
public void setKey(java.util.Map.Entry
* 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.
*
* @param hashKey
* a map entry including the name and value of the primary hash key.
* @param rangeKey
* a map entry including the name and value of the primary range key, or null if it is a hash-only table.
*/
public DeleteItemRequest withKey(java.util.Map.Entry