DeleteItemRequest (AWS SDK for Java

Overview

Package

Class

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.dynamodb.model
Class DeleteItemRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.dynamodb.model.DeleteItemRequest

public class DeleteItemRequest
extends AmazonWebServiceRequest
extends AmazonWebServiceRequest

Container for the parameters to the DeleteItem operation.

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.

See Also:: AmazonDynamoDB.deleteItem(DeleteItemRequest)

Constructor Summary
`DeleteItemRequest()` Default constructor for a new DeleteItemRequest object.
`DeleteItemRequest(String tableName, Key key)` Constructs a new DeleteItemRequest object.

Method Summary
`boolean`	`equals(Object obj)`
`Map<String,ExpectedAttributeValue>`	`getExpected()` Designates an attribute for a conditional modification.
`Key`	`getKey()` The primary key that uniquely identifies each item in a table.
`String`	`getReturnValues()` Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
`String`	`getTableName()` Returns the value of the TableName property for this object.
`int`	`hashCode()`
`void`	`setExpected(Map<String,ExpectedAttributeValue> expected)` Designates an attribute for a conditional modification.
`void`	`setKey(Key key)` The primary key that uniquely identifies each item in a table.
`void`	`setReturnValues(ReturnValue returnValues)` Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
`void`	`setReturnValues(String returnValues)` Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
`void`	`setTableName(String tableName)` Sets the value of the TableName property for this object.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DeleteItemRequest`	`withExpected(Map<String,ExpectedAttributeValue> expected)` Designates an attribute for a conditional modification.
`DeleteItemRequest`	`withKey(Key key)` The primary key that uniquely identifies each item in a table.
`DeleteItemRequest`	`withReturnValues(ReturnValue returnValues)` Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
`DeleteItemRequest`	`withReturnValues(String returnValues)` Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
`DeleteItemRequest`	`withTableName(String tableName)` Sets the value of the TableName property for this object.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
`copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

DeleteItemRequest

public DeleteItemRequest()

Default constructor for a new DeleteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DeleteItemRequest

public DeleteItemRequest(String tableName,
                         Key key)

Constructs a new DeleteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:: tableName -; key - The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Method Detail

getTableName

public String getTableName()

Returns the value of the TableName property for this object.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:: The value of the TableName property for this object.

setTableName

public void setTableName(String tableName)

Sets the value of the TableName property for this object.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:: tableName - The new value for the TableName property for this object.

withTableName

public DeleteItemRequest withTableName(String tableName)

Sets the value of the TableName property for this object.

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

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:: tableName - The new value for the TableName property for this object.
Returns:: A reference to this updated object so that method calls can be chained together.

getKey

public Key getKey()

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Returns:: The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

setKey

public void setKey(Key key)

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Parameters:: key - The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

withKey

public DeleteItemRequest withKey(Key key)

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

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

Parameters:: key - The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.
Returns:: A reference to this updated object so that method calls can be chained together.

getExpected

public Map<String,ExpectedAttributeValue> getExpected()

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

Returns:: Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

setExpected

public void setExpected(Map<String,ExpectedAttributeValue> expected)

Parameters:: expected - Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

withExpected

public DeleteItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)

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

Parameters:: expected - Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.
Returns:: A reference to this updated object so that method calls can be chained together.

getReturnValues

public String getReturnValues()

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For put operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW. NONE : Nothing is returned. ALL_OLD : Returns the attributes of the item as they were before the operation. UPDATED_OLD : Returns the values of the updated attributes, only, as they were before the operation. ALL_NEW : Returns all the attributes and their new values after the operation. UPDATED_NEW : Returns the values of the updated attributes, only, as they are after the operation.