com.amazonaws.services.sqs.model
Class ChangeMessageVisibilityBatchRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequest

public class ChangeMessageVisibilityBatchRequest
extends AmazonWebServiceRequest

Container for the parameters to the ChangeMessageVisibilityBatch operation.

This is a batch version of ChangeMessageVisibility. It takes multiple receipt handles and performs the operation on each of the them. The result of the operation on each message is reported individually in the response.

See Also:
AmazonSQS.changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest)

Constructor Summary
ChangeMessageVisibilityBatchRequest()
          Default constructor for a new ChangeMessageVisibilityBatchRequest object.
ChangeMessageVisibilityBatchRequest(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries)
          Constructs a new ChangeMessageVisibilityBatchRequest object.
 
Method Summary
 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 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 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 SQS queue to take action on.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials
 
Methods inherited from class java.lang.Object
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 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 SQS queue to take action on.

Returns:
The URL of the SQS queue to take action on.

setQueueUrl

public void setQueueUrl(String queueUrl)
The URL of the SQS queue to take action on.

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

withQueueUrl

public ChangeMessageVisibilityBatchRequest withQueueUrl(String queueUrl)
The URL of the 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 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.

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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.