com.amazonaws.services.simpledb.model

Class DeleteAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpledb.model.DeleteAttributesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DeleteAttributesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the DeleteAttributes operation.

Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.

NOTE: If DeleteAttributes is called without being passed any attributes or values specified, all the attributes for the item are deleted.

DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data.

See Also:

AmazonSimpleDB.deleteAttributes(DeleteAttributesRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeleteAttributesRequest() Default constructor for a new DeleteAttributesRequest object.
DeleteAttributesRequest(java.lang.String domainName, java.lang.String itemName) Constructs a new DeleteAttributesRequest object.
DeleteAttributesRequest(java.lang.String domainName, java.lang.String itemName, java.util.List<Attribute> attributes) Constructs a new DeleteAttributesRequest object.
DeleteAttributesRequest(java.lang.String domainName, java.lang.String itemName, java.util.List<Attribute> attributes, UpdateCondition expected) Constructs a new DeleteAttributesRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<Attribute>	getAttributes() A list of Attributes.
java.lang.String	getDomainName() The name of the domain in which to perform the operation.
UpdateCondition	getExpected() The update condition which, if specified, determines whether the specified attributes will be deleted or not.
java.lang.String	getItemName() The name of the item.
int	hashCode()
void	setAttributes(java.util.Collection<Attribute> attributes) A list of Attributes.
void	setDomainName(java.lang.String domainName) The name of the domain in which to perform the operation.
void	setExpected(UpdateCondition expected) The update condition which, if specified, determines whether the specified attributes will be deleted or not.
void	setItemName(java.lang.String itemName) The name of the item.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteAttributesRequest	withAttributes(Attribute... attributes) A list of Attributes.
DeleteAttributesRequest	withAttributes(java.util.Collection<Attribute> attributes) A list of Attributes.
DeleteAttributesRequest	withDomainName(java.lang.String domainName) The name of the domain in which to perform the operation.
DeleteAttributesRequest	withExpected(UpdateCondition expected) The update condition which, if specified, determines whether the specified attributes will be deleted or not.
DeleteAttributesRequest	withItemName(java.lang.String itemName) The name of the item.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteAttributesRequest

public DeleteAttributesRequest()

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

DeleteAttributesRequest

public DeleteAttributesRequest(java.lang.String domainName,
                               java.lang.String itemName)

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

Parameters:

domainName - The name of the domain in which to perform the operation.

itemName - The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

DeleteAttributesRequest

public DeleteAttributesRequest(java.lang.String domainName,
                               java.lang.String itemName,
                               java.util.List<Attribute> attributes)

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

Parameters:

domainName - The name of the domain in which to perform the operation.

itemName - The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

attributes - A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

DeleteAttributesRequest

public DeleteAttributesRequest(java.lang.String domainName,
                               java.lang.String itemName,
                               java.util.List<Attribute> attributes,
                               UpdateCondition expected)

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

Parameters:

domainName - The name of the domain in which to perform the operation.

itemName - The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

attributes - A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

expected - The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

Method Detail

getDomainName

public java.lang.String getDomainName()

The name of the domain in which to perform the operation.

Returns:

The name of the domain in which to perform the operation.

setDomainName

public void setDomainName(java.lang.String domainName)

The name of the domain in which to perform the operation.

Parameters:

domainName - The name of the domain in which to perform the operation.

withDomainName

public DeleteAttributesRequest withDomainName(java.lang.String domainName)

The name of the domain in which to perform the operation.

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

Parameters:

domainName - The name of the domain in which to perform the operation.

Returns:

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

getItemName

public java.lang.String getItemName()

The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

Returns:

The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

setItemName

public void setItemName(java.lang.String itemName)

The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

Parameters:

itemName - The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

withItemName

public DeleteAttributesRequest withItemName(java.lang.String itemName)

The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

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

Parameters:

itemName - The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

Returns:

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

getAttributes

public java.util.List<Attribute> getAttributes()

A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

Returns:

A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

setAttributes

public void setAttributes(java.util.Collection<Attribute> attributes)

A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

Parameters:

attributes - A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

withAttributes

public DeleteAttributesRequest withAttributes(Attribute... attributes)

A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

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

Parameters:

attributes - A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

Returns:

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

withAttributes

public DeleteAttributesRequest withAttributes(java.util.Collection<Attribute> attributes)

A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

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

Parameters:

attributes - A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

Returns:

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

getExpected

public UpdateCondition getExpected()

The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

Returns:

The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

setExpected

public void setExpected(UpdateCondition expected)

The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

Parameters:

expected - The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

withExpected

public DeleteAttributesRequest withExpected(UpdateCondition expected)

The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

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

Parameters:

expected - The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object