Overview | Package | Class | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.amazonaws.services.sqs.model
Class ChangeMessageVisibilityRequest

    java.lang.Object
      com.amazonaws.AmazonWebServiceRequest
          com.amazonaws.services.sqs.model.ChangeMessageVisibilityRequest

    public class ChangeMessageVisibilityRequest

extends AmazonWebServiceRequest

Container for the parameters to the `ChangeMessageVisibility operation`.

The ChangeMessageVisibility action changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)

For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes.

IMPORTANT: If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.

IMPORTANT: Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.

See Also:
  `AmazonSQS.changeMessageVisibility(ChangeMessageVisibilityRequest)`

Constructor Summary
`ChangeMessageVisibilityRequest()` Default constructor for a new ChangeMessageVisibilityRequest object.
`ChangeMessageVisibilityRequest(String queueUrl, String receiptHandle, Integer visibilityTimeout)` Constructs a new ChangeMessageVisibilityRequest object.

Method Summary
`String` | `getQueueUrl()`
`String` | `getReceiptHandle()` The receipt handle associated with the message whose visibility timeout the client wants to change.
`Integer` | `getVisibilityTimeout()` The new value (in seconds) for the message's visibility timeout.
`void` | `setQueueUrl(String queueUrl)`
`void` | `setReceiptHandle(String receiptHandle)` The receipt handle associated with the message whose visibility timeout the client wants to change.
`void` | `setVisibilityTimeout(Integer visibilityTimeout)` The new value (in seconds) for the message's visibility timeout.
`String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
`ChangeMessageVisibilityRequest` | `withQueueUrl(String queueUrl)` Returns a reference to this object so that method calls can be chained together.
`ChangeMessageVisibilityRequest` | `withReceiptHandle(String receiptHandle)` The receipt handle associated with the message whose visibility timeout the client wants to change.
`ChangeMessageVisibilityRequest` | `withVisibilityTimeout(Integer visibilityTimeout)` The new value (in seconds) for the message's visibility timeout.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
`copyPrivateRequestParameters`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### ChangeMessageVisibilityRequest

    public ChangeMessageVisibilityRequest()

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

### ChangeMessageVisibilityRequest

    public ChangeMessageVisibilityRequest(String queueUrl,
                                          String receiptHandle,
                                          Integer visibilityTimeout)

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

  Parameters:
    `queueUrl` -
    `receiptHandle` - The receipt handle associated with the message whose visibility timeout the client wants to change.
    `visibilityTimeout` - The new value (in seconds) for the message's visibility timeout.

Method Detail

### getQueueUrl

    public String getQueueUrl()

  Returns:

### setQueueUrl

    public void setQueueUrl(String queueUrl)

  Parameters:
    `queueUrl` -

### withQueueUrl

    public ChangeMessageVisibilityRequest withQueueUrl(String queueUrl)

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

  Parameters:
    `queueUrl` -
  Returns:
    A reference to this updated object so that method calls can be chained together.

### getReceiptHandle

    public String getReceiptHandle()

  The receipt handle associated with the message whose visibility timeout the client wants to change.

  Returns:
    The receipt handle associated with the message whose visibility timeout the client wants to change.

### setReceiptHandle

    public void setReceiptHandle(String receiptHandle)

  The receipt handle associated with the message whose visibility timeout the client wants to change.

  Parameters:
    `receiptHandle` - The receipt handle associated with the message whose visibility timeout the client wants to change.

### withReceiptHandle

    public ChangeMessageVisibilityRequest withReceiptHandle(String receiptHandle)

  The receipt handle associated with the message whose visibility timeout the client wants to change.

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

  Parameters:
    `receiptHandle` - The receipt handle associated with the message whose visibility timeout the client wants to change.
  Returns:
    A reference to this updated object so that method calls can be chained together.

### getVisibilityTimeout

    public Integer getVisibilityTimeout()

  The new value (in seconds) for the message's visibility timeout.

  Returns:
    The new value (in seconds) for the message's visibility timeout.

### setVisibilityTimeout

    public void setVisibilityTimeout(Integer visibilityTimeout)

  The new value (in seconds) for the message's visibility timeout.

  Parameters:
    `visibilityTimeout` - The new value (in seconds) for the message's visibility timeout.

### withVisibilityTimeout

    public ChangeMessageVisibilityRequest withVisibilityTimeout(Integer visibilityTimeout)

  The new value (in seconds) for the message's visibility timeout.

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

  Parameters:
    `visibilityTimeout` - The new value (in seconds) for the message's visibility timeout.
  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()`

Overview | Package | Class | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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