com.amazonaws.services.sqs.model

Class DeleteMessageBatchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.DeleteMessageBatchRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeleteMessageBatchRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteMessageBatchRequest() Default constructor for DeleteMessageBatchRequest object.
DeleteMessageBatchRequest(String queueUrl) Constructs a new DeleteMessageBatchRequest object.
DeleteMessageBatchRequest(String queueUrl, List<DeleteMessageBatchRequestEntry> entries) Constructs a new DeleteMessageBatchRequest object.

Method Summary

Modifier and Type	Method and Description
DeleteMessageBatchRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<DeleteMessageBatchRequestEntry>	getEntries() A list of receipt handles for the messages to be deleted.
String	getQueueUrl() The URL of the Amazon SQS queue from which messages are deleted.
int	hashCode()
void	setEntries(Collection<DeleteMessageBatchRequestEntry> entries) A list of receipt handles for the messages to be deleted.
void	setQueueUrl(String queueUrl) The URL of the Amazon SQS queue from which messages are deleted.
String	toString() Returns a string representation of this object.
DeleteMessageBatchRequest	withEntries(Collection<DeleteMessageBatchRequestEntry> entries) A list of receipt handles for the messages to be deleted.
DeleteMessageBatchRequest	withEntries(DeleteMessageBatchRequestEntry... entries) A list of receipt handles for the messages to be deleted.
DeleteMessageBatchRequest	withQueueUrl(String queueUrl) The URL of the Amazon SQS queue from which messages are deleted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteMessageBatchRequest

public DeleteMessageBatchRequest()

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

DeleteMessageBatchRequest

public DeleteMessageBatchRequest(String queueUrl)

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

Parameters:

queueUrl - The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

DeleteMessageBatchRequest

public DeleteMessageBatchRequest(String queueUrl,
                                 List<DeleteMessageBatchRequestEntry> entries)

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

Parameters:

queueUrl - The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

entries - A list of receipt handles for the messages to be deleted.

Method Detail

setQueueUrl

public void setQueueUrl(String queueUrl)

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

Parameters:

queueUrl - The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

getQueueUrl

public String getQueueUrl()

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

Returns:

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

withQueueUrl

public DeleteMessageBatchRequest withQueueUrl(String queueUrl)

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

Parameters:

queueUrl - The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

Returns:

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

getEntries

public List<DeleteMessageBatchRequestEntry> getEntries()

A list of receipt handles for the messages to be deleted.

Returns:

A list of receipt handles for the messages to be deleted.

setEntries

public void setEntries(Collection<DeleteMessageBatchRequestEntry> entries)

A list of receipt handles for the messages to be deleted.

Parameters:

entries - A list of receipt handles for the messages to be deleted.

withEntries

public DeleteMessageBatchRequest withEntries(DeleteMessageBatchRequestEntry... entries)

A list of receipt handles for the messages to be deleted.

NOTE: This method appends the values to the existing list (if any). Use setEntries(java.util.Collection) or withEntries(java.util.Collection) if you want to override the existing values.

Parameters:

entries - A list of receipt handles for the messages to be deleted.

Returns:

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

withEntries

public DeleteMessageBatchRequest withEntries(Collection<DeleteMessageBatchRequestEntry> entries)

A list of receipt handles for the messages to be deleted.

Parameters:

entries - A list of receipt handles for the messages to be deleted.

Returns:

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeleteMessageBatchRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()