DeleteItemRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DeleteItemRequest.Builder,DeleteItemRequest>, DynamoDbRequest.Builder, SdkBuilder<DeleteItemRequest.Builder,DeleteItemRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DeleteItemRequest
```
public static interface DeleteItemRequest.Builder
extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder<DeleteItemRequest.Builder,DeleteItemRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DeleteItemRequest.Builder`	`conditionalOperator(ConditionalOperator conditionalOperator)` This is a legacy parameter.
`DeleteItemRequest.Builder`	`conditionalOperator(String conditionalOperator)` This is a legacy parameter.
`DeleteItemRequest.Builder`	`conditionExpression(String conditionExpression)` A condition that must be satisfied in order for a conditional `DeleteItem` to succeed.
`DeleteItemRequest.Builder`	`expected(Map<String,ExpectedAttributeValue> expected)` This is a legacy parameter.
`DeleteItemRequest.Builder`	`expressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`DeleteItemRequest.Builder`	`expressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`DeleteItemRequest.Builder`	`key(Map<String,AttributeValue> key)` A map of attribute names to `AttributeValue` objects, representing the primary key of the item to delete.
`DeleteItemRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`DeleteItemRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`DeleteItemRequest.Builder`	`returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)` Sets the value of the ReturnConsumedCapacity property for this object.
`DeleteItemRequest.Builder`	`returnConsumedCapacity(String returnConsumedCapacity)` Sets the value of the ReturnConsumedCapacity property for this object.
`DeleteItemRequest.Builder`	`returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)` Determines whether item collection metrics are returned.
`DeleteItemRequest.Builder`	`returnItemCollectionMetrics(String returnItemCollectionMetrics)` Determines whether item collection metrics are returned.
`DeleteItemRequest.Builder`	`returnValues(ReturnValue returnValues)` Use `ReturnValues` if you want to get the item attributes as they appeared before they were deleted.
`DeleteItemRequest.Builder`	`returnValues(String returnValues)` Use `ReturnValues` if you want to get the item attributes as they appeared before they were deleted.
`DeleteItemRequest.Builder`	`tableName(String tableName)` The name of the table from which to delete the item.

Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - tableName
```
DeleteItemRequest.Builder tableName(String tableName)
```
    The name of the table from which to delete the item.
    
    Parameters:
    
    tableName - The name of the table from which to delete the item.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - key
```
DeleteItemRequest.Builder key(Map<String,AttributeValue> key)
```
    A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
    
    For the primary key, you must provide all of the 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - expected
```
DeleteItemRequest.Builder expected(Map<String,ExpectedAttributeValue> expected)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    expected - This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - conditionalOperator
```
DeleteItemRequest.Builder conditionalOperator(String conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConditionalOperator, ConditionalOperator
  - conditionalOperator
```
DeleteItemRequest.Builder conditionalOperator(ConditionalOperator conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConditionalOperator, ConditionalOperator
  - returnValues
```
DeleteItemRequest.Builder returnValues(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnValue, ReturnValue
  - returnValues
```
DeleteItemRequest.Builder returnValues(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnValue, ReturnValue
  - returnConsumedCapacity
```
DeleteItemRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)
```
    Sets the value of the ReturnConsumedCapacity property for this object.
    
    Parameters:
    
    returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnConsumedCapacity, ReturnConsumedCapacity
  - returnConsumedCapacity
```
DeleteItemRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
```
    Sets the value of the ReturnConsumedCapacity property for this object.
    
    Parameters:
    
    returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnConsumedCapacity, ReturnConsumedCapacity
  - returnItemCollectionMetrics
```
DeleteItemRequest.Builder returnItemCollectionMetrics(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnItemCollectionMetrics, ReturnItemCollectionMetrics
  - returnItemCollectionMetrics
```
DeleteItemRequest.Builder returnItemCollectionMetrics(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnItemCollectionMetrics, ReturnItemCollectionMetrics
  - conditionExpression
```
DeleteItemRequest.Builder conditionExpression(String conditionExpression)
```
    A condition that must be satisfied in order for a conditional DeleteItem to succeed.
    
    An expression can contain any of the following:
    - Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
      
      These function names are case-sensitive.
    - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    - Logical operators: AND | OR | NOT
    For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - expressionAttributeNames
```
DeleteItemRequest.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
    - To access an attribute whose name conflicts with a DynamoDB reserved word.
    - To create a placeholder for repeating occurrences of an attribute name in an expression.
    - To prevent special characters in an attribute name from being misinterpreted in an expression.
    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
    - Percentile
    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
    - {"#P":"Percentile"}
    You could then use this substitution in an expression, as in this example:
    - #P = :val
    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
    
    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
    Parameters:
    expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
    
    To access an attribute whose name conflicts with a DynamoDB reserved word.
    
    To create a placeholder for repeating occurrences of an attribute name in an expression.
    
    To prevent special characters in an attribute name from being misinterpreted in an expression.
    
    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
    
    Percentile
    
    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
    
    {"#P":"Percentile"}
    
    You could then use this substitution in an expression, as in this example:
    
    #P = :val
    
    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
    
    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - expressionAttributeValues
```
DeleteItemRequest.Builder expressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
```
    One or more values that can be substituted in an expression.
    
    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
    
    Available | Backordered | Discontinued
    
    You would first need to specify ExpressionAttributeValues as follows:
    
    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
    
    You could then use these values in an expression, such as this:
    
    ProductStatus IN (:avail, :back, :disc)
    
    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    expressionAttributeValues - One or more values that can be substituted in an expression.
    
    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
    
    Available | Backordered | Discontinued
    
    You would first need to specify ExpressionAttributeValues as follows:
    
    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
    
    You could then use these values in an expression, such as this:
    
    ProductStatus IN (:avail, :back, :disc)
    
    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
DeleteItemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
DeleteItemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface DeleteItemRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

tableName

key

expected

conditionalOperator

conditionalOperator

returnValues

returnValues

returnConsumedCapacity

returnConsumedCapacity

returnItemCollectionMetrics

returnItemCollectionMetrics

conditionExpression

expressionAttributeNames

expressionAttributeValues

overrideConfiguration

overrideConfiguration