com.amazonaws.services.dynamodbv2.model

Class DeleteRequest

java.lang.Object

com.amazonaws.services.dynamodbv2.model.DeleteRequest

All Implemented Interfaces:

Serializable

public class DeleteRequest
extends Object
implements Serializable

Represents a request to perform a DeleteItem operation on an item.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeleteRequest() Default constructor for a new DeleteRequest object.
DeleteRequest(Map<String,AttributeValue> key) Constructs a new DeleteRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DeleteRequest	addKeyEntry(String key, AttributeValue value) A map of attribute name to attribute values, representing the primary key of the item to delete.
DeleteRequest	clearKeyEntries() Removes all the entries added into Key.
boolean	equals(Object obj)
Map<String,AttributeValue>	getKey() A map of attribute name to attribute values, representing the primary key of the item to delete.
int	hashCode()
void	setKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) A map of attribute name to attribute values, representing the primary key of the item to delete.
void	setKey(Map<String,AttributeValue> key) A map of attribute name to attribute values, representing the primary key of the item to delete.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteRequest	withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) A map of attribute name to attribute values, representing the primary key of the item to delete.
DeleteRequest	withKey(Map<String,AttributeValue> key) A map of attribute name to attribute values, representing the primary key of the item to delete.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteRequest

public DeleteRequest()

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

DeleteRequest

public DeleteRequest(Map<String,AttributeValue> key)

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

Parameters:

key - A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

Method Detail

getKey

public Map<String,AttributeValue> getKey()

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

Returns:

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

setKey

public void setKey(Map<String,AttributeValue> key)

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

Parameters:

key - A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

withKey

public DeleteRequest withKey(Map<String,AttributeValue> key)

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

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

Parameters:

key - A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

Returns:

A reference to this updated object so that method calls can be chained together.

setKey

public void setKey(Map.Entry<String,AttributeValue> hashKey,
          Map.Entry<String,AttributeValue> rangeKey)
            throws IllegalArgumentException

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

This method accepts the hashKey, rangeKey of Key as java.util.Map.Entry objects.

Parameters:

hashKey - Primary hash key.

rangeKey - Primary range key. (null if it a hash-only table)

Throws:

IllegalArgumentException

withKey

public DeleteRequest withKey(Map.Entry<String,AttributeValue> hashKey,
                    Map.Entry<String,AttributeValue> rangeKey)
                      throws IllegalArgumentException

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

This method accepts the hashKey, rangeKey of Key as java.util.Map.Entry objects.

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

Parameters:

hashKey - Primary hash key.

rangeKey - Primary range key. (null if it a hash-only table)

Throws:

IllegalArgumentException

addKeyEntry

public DeleteRequest addKeyEntry(String key,
                        AttributeValue value)

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

The method adds a new key-value pair into Key parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Key.

value - The corresponding value of the entry to be added into Key.

clearKeyEntries

public DeleteRequest clearKeyEntries()

Removes all the entries added into Key.

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object