com.amazonaws.services.sqs.model

Class ChangeMessageVisibilityBatchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ChangeMessageVisibilityBatchRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ChangeMessageVisibilityBatch operation.

Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

IMPORTANT:Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

NOTE:Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

See Also:

AmazonSQS.changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ChangeMessageVisibilityBatchRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<ChangeMessageVisibilityBatchRequestEntry>	getEntries() A list of receipt handles of the messages for which the visibility timeout must be changed.
String	getQueueUrl() The URL of the Amazon SQS queue to take action on.
int	hashCode()
void	setEntries(Collection<ChangeMessageVisibilityBatchRequestEntry> entries) A list of receipt handles of the messages for which the visibility timeout must be changed.
void	setQueueUrl(String queueUrl) The URL of the Amazon SQS queue to take action on.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ChangeMessageVisibilityBatchRequest	withEntries(ChangeMessageVisibilityBatchRequestEntry... entries) A list of receipt handles of the messages for which the visibility timeout must be changed.
ChangeMessageVisibilityBatchRequest	withEntries(Collection<ChangeMessageVisibilityBatchRequestEntry> entries) A list of receipt handles of the messages for which the visibility timeout must be changed.
ChangeMessageVisibilityBatchRequest	withQueueUrl(String queueUrl) The URL of the Amazon SQS queue to take action on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeMessageVisibilityBatchRequest

public ChangeMessageVisibilityBatchRequest()

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

ChangeMessageVisibilityBatchRequest

public ChangeMessageVisibilityBatchRequest(String queueUrl,
                                   List<ChangeMessageVisibilityBatchRequestEntry> entries)

Constructs a new ChangeMessageVisibilityBatchRequest 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 to take action on.

entries - A list of receipt handles of the messages for which the visibility timeout must be changed.

Method Detail

getQueueUrl

public String getQueueUrl()

The URL of the Amazon SQS queue to take action on.

Returns:

The URL of the Amazon SQS queue to take action on.

setQueueUrl

public void setQueueUrl(String queueUrl)

The URL of the Amazon SQS queue to take action on.

Parameters:

queueUrl - The URL of the Amazon SQS queue to take action on.

withQueueUrl

public ChangeMessageVisibilityBatchRequest withQueueUrl(String queueUrl)

The URL of the Amazon SQS queue to take action on.

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

Parameters:

queueUrl - The URL of the Amazon SQS queue to take action on.

Returns:

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

getEntries

public List<ChangeMessageVisibilityBatchRequestEntry> getEntries()

A list of receipt handles of the messages for which the visibility timeout must be changed.

Returns:

A list of receipt handles of the messages for which the visibility timeout must be changed.

setEntries

public void setEntries(Collection<ChangeMessageVisibilityBatchRequestEntry> entries)

A list of receipt handles of the messages for which the visibility timeout must be changed.

Parameters:

entries - A list of receipt handles of the messages for which the visibility timeout must be changed.

withEntries

public ChangeMessageVisibilityBatchRequest withEntries(ChangeMessageVisibilityBatchRequestEntry... entries)

A list of receipt handles of the messages for which the visibility timeout must be changed.

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.

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

Parameters:

entries - A list of receipt handles of the messages for which the visibility timeout must be changed.

Returns:

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

withEntries

public ChangeMessageVisibilityBatchRequest withEntries(Collection<ChangeMessageVisibilityBatchRequestEntry> entries)

A list of receipt handles of the messages for which the visibility timeout must be changed.

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

Parameters:

entries - A list of receipt handles of the messages for which the visibility timeout must be changed.

Returns:

A reference to this updated 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

clone

public ChangeMessageVisibilityBatchRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()