Package software.amazon.awssdk.services.dynamodb.model

Interface DeleteItemRequest.Builder

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 Details

    • tableName

      DeleteItemRequest.Builder tableName(String tableName)

      The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      Parameters:
      tableName - The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
      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 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.

      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 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.

      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

      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:

    • 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.

      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.

      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.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

      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.

      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.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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:

    • 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

      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:

    • 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.

    • returnValuesOnConditionCheckFailure

      DeleteItemRequest.Builder returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)

      An optional parameter that returns the item attributes for a DeleteItem operation that failed a condition check.

      There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • returnValuesOnConditionCheckFailure

      DeleteItemRequest.Builder returnValuesOnConditionCheckFailure(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      DeleteItemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DeleteItemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.