@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DeleteRequest extends Object implements Serializable, Cloneable, StructuredPojo
Represents a request to perform a DeleteItem
operation on an item.
Constructor and Description |
---|
DeleteRequest()
Default constructor for DeleteRequest object.
|
DeleteRequest(Map<String,AttributeValue> key)
Constructs a new DeleteRequest object.
|
Modifier and Type | Method and Description |
---|---|
DeleteRequest |
addKeyEntry(String key,
AttributeValue value)
Add a single Key entry
|
DeleteRequest |
clearKeyEntries()
Removes all the entries added into Key.
|
DeleteRequest |
clone() |
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 |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
Set the hash and range key attributes of the item.
|
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.
|
DeleteRequest |
withKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
Set the hash and range key attributes of the item.
|
DeleteRequest |
withKey(Map<String,AttributeValue> key)
A map of attribute name to attribute values, representing the primary key of the item to delete.
|
public DeleteRequest()
public DeleteRequest(Map<String,AttributeValue> key)
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.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.
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.
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.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.
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.public DeleteRequest addKeyEntry(String key, AttributeValue value)
public DeleteRequest clearKeyEntries()
public void setKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.
hashKey
- a map entry including the name and value of the primary hash key.rangeKey
- a map entry including the name and value of the primary range key, or null if it is a hash-only table.IllegalArgumentException
public DeleteRequest withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
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.
hashKey
- a map entry including the name and value of the primary hash key.rangeKey
- a map entry including the name and value of the primary range key, or null if it is a hash-only table.IllegalArgumentException
public String toString()
toString
in class Object
Object.toString()
public DeleteRequest clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.