ReceiveMessageRequest (AWS Java SDK for Amazon SQS 1.11.578 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sqs.model.ReceiveMessageRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReceiveMessageRequest
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
`ReceiveMessageRequest()` Default constructor for ReceiveMessageRequest object.
`ReceiveMessageRequest(String queueUrl)` Constructs a new ReceiveMessageRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReceiveMessageRequest`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAttributeNames()` A list of s that need to be returned along with each message.
`Integer`	`getMaxNumberOfMessages()` The maximum number of messages to return.
`List<String>`	`getMessageAttributeNames()` The name of the message attribute, where N is the index.
`String`	`getQueueUrl()` The URL of the Amazon SQS queue from which messages are received.
`String`	`getReceiveRequestAttemptId()` This parameter applies only to FIFO (first-in-first-out) queues.
`Integer`	`getVisibilityTimeout()` The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a `ReceiveMessage` request.
`Integer`	`getWaitTimeSeconds()` The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.
`int`	`hashCode()`
`void`	`setAttributeNames(Collection<String> attributeNames)` A list of s that need to be returned along with each message.
`void`	`setMaxNumberOfMessages(Integer maxNumberOfMessages)` The maximum number of messages to return.
`void`	`setMessageAttributeNames(Collection<String> messageAttributeNames)` The name of the message attribute, where N is the index.
`void`	`setQueueUrl(String queueUrl)` The URL of the Amazon SQS queue from which messages are received.
`void`	`setReceiveRequestAttemptId(String receiveRequestAttemptId)` This parameter applies only to FIFO (first-in-first-out) queues.
`void`	`setVisibilityTimeout(Integer visibilityTimeout)` The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a `ReceiveMessage` request.
`void`	`setWaitTimeSeconds(Integer waitTimeSeconds)` The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.
`String`	`toString()` Returns a string representation of this object.
`ReceiveMessageRequest`	`withAttributeNames(Collection<String> attributeNames)` A list of s that need to be returned along with each message.
`ReceiveMessageRequest`	`withAttributeNames(QueueAttributeName... attributeNames)` A list of s that need to be returned along with each message.
`ReceiveMessageRequest`	`withAttributeNames(String... attributeNames)` A list of s that need to be returned along with each message.
`ReceiveMessageRequest`	`withMaxNumberOfMessages(Integer maxNumberOfMessages)` The maximum number of messages to return.
`ReceiveMessageRequest`	`withMessageAttributeNames(Collection<String> messageAttributeNames)` The name of the message attribute, where N is the index.
`ReceiveMessageRequest`	`withMessageAttributeNames(String... messageAttributeNames)` The name of the message attribute, where N is the index.
`ReceiveMessageRequest`	`withQueueUrl(String queueUrl)` The URL of the Amazon SQS queue from which messages are received.
`ReceiveMessageRequest`	`withReceiveRequestAttemptId(String receiveRequestAttemptId)` This parameter applies only to FIFO (first-in-first-out) queues.
`ReceiveMessageRequest`	`withVisibilityTimeout(Integer visibilityTimeout)` The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a `ReceiveMessage` request.
`ReceiveMessageRequest`	`withWaitTimeSeconds(Integer waitTimeSeconds)` The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ReceiveMessageRequest
```
public ReceiveMessageRequest()
```
    Default constructor for ReceiveMessageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - ReceiveMessageRequest
```
public ReceiveMessageRequest(String queueUrl)
```
    Constructs a new ReceiveMessageRequest 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 received.
    
    Queue URLs and names are case-sensitive.
- Method Detail
  - setQueueUrl
```
public void setQueueUrl(String queueUrl)
```
    The URL of the Amazon SQS queue from which messages are received.
    
    Queue URLs and names are case-sensitive.
    
    Parameters:
    
    queueUrl - The URL of the Amazon SQS queue from which messages are received.
    
    Queue URLs and names are case-sensitive.
  - getQueueUrl
```
public String getQueueUrl()
```
    The URL of the Amazon SQS queue from which messages are received.
    
    Queue URLs and names are case-sensitive.
    
    Returns:
    
    The URL of the Amazon SQS queue from which messages are received.
    
    Queue URLs and names are case-sensitive.
  - withQueueUrl
```
public ReceiveMessageRequest withQueueUrl(String queueUrl)
```
    The URL of the Amazon SQS queue from which messages are received.
    
    Queue URLs and names are case-sensitive.
    
    Parameters:
    
    queueUrl - The URL of the Amazon SQS queue from which messages are received.
    
    Queue URLs and names are case-sensitive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributeNames
```
public List<String> getAttributeNames()
```
    A list of s that need to be returned along with each message. These attributes include:
    - All - Returns all values.
    - ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    - ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    - SenderId
      
      For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
      
      For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    - SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    - MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    - MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    - SequenceNumber - Returns the value provided by Amazon SQS.
    Returns:
    A list of s that need to be returned along with each message. These attributes include:
    
    All - Returns all values.
    
    ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    
    ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    
    SenderId
    
    For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
    
    For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    
    SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    
    MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    
    MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    
    SequenceNumber - Returns the value provided by Amazon SQS.
    See Also:
    
    QueueAttributeName
  - setAttributeNames
```
public void setAttributeNames(Collection<String> attributeNames)
```
    A list of s that need to be returned along with each message. These attributes include:
    - All - Returns all values.
    - ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    - ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    - SenderId
      
      For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
      
      For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    - SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    - MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    - MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    - SequenceNumber - Returns the value provided by Amazon SQS.
    Parameters:
    attributeNames - A list of s that need to be returned along with each message. These attributes include:
    
    All - Returns all values.
    
    ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    
    ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    
    SenderId
    
    For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
    
    For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    
    SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    
    MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    
    MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    
    SequenceNumber - Returns the value provided by Amazon SQS.
    See Also:
    
    QueueAttributeName
  - withAttributeNames
```
public ReceiveMessageRequest withAttributeNames(String... attributeNames)
```
    A list of s that need to be returned along with each message. These attributes include:
    - All - Returns all values.
    - ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    - ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    - SenderId
      
      For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
      
      For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    - SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    - MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    - MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    - SequenceNumber - Returns the value provided by Amazon SQS.
    NOTE: This method appends the values to the existing list (if any). Use setAttributeNames(java.util.Collection) or withAttributeNames(java.util.Collection) if you want to override the existing values.
    Parameters:
    attributeNames - A list of s that need to be returned along with each message. These attributes include:
    
    All - Returns all values.
    
    ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    
    ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    
    SenderId
    
    For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
    
    For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    
    SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    
    MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    
    MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    
    SequenceNumber - Returns the value provided by Amazon SQS.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueueAttributeName
  - withAttributeNames
```
public ReceiveMessageRequest withAttributeNames(Collection<String> attributeNames)
```
    A list of s that need to be returned along with each message. These attributes include:
    - All - Returns all values.
    - ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    - ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    - SenderId
      
      For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
      
      For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    - SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    - MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    - MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    - SequenceNumber - Returns the value provided by Amazon SQS.
    Parameters:
    attributeNames - A list of s that need to be returned along with each message. These attributes include:
    
    All - Returns all values.
    
    ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    
    ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    
    SenderId
    
    For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
    
    For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    
    SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    
    MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    
    MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    
    SequenceNumber - Returns the value provided by Amazon SQS.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueueAttributeName
  - withAttributeNames
```
public ReceiveMessageRequest withAttributeNames(QueueAttributeName... attributeNames)
```
    A list of s that need to be returned along with each message. These attributes include:
    - All - Returns all values.
    - ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    - ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    - SenderId
      
      For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
      
      For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    - SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    - MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    - MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    - SequenceNumber - Returns the value provided by Amazon SQS.
    Parameters:
    attributeNames - A list of s that need to be returned along with each message. These attributes include:
    
    All - Returns all values.
    
    ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
    
    ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
    
    SenderId
    
    For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
    
    For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
    
    SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
    
    MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
    
    MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
    
    SequenceNumber - Returns the value provided by Amazon SQS.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueueAttributeName
  - getMessageAttributeNames
```
public List<String> getMessageAttributeNames()
```
    The name of the message attribute, where N is the index.
    - The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
    - The name is case-sensitive and must be unique among all attribute names for the message.
    - The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    - The name must not start or end with a period (.), and it should not have periods in succession ( ..).
    - The name can be up to 256 characters long.
    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
    Returns:
    The name of the message attribute, where N is the index.
    
    The name can contain alphanumeric characters and the underscore (_), hyphen (- ), and period (.).
    
    The name is case-sensitive and must be unique among all attribute names for the message.
    
    The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    
    The name must not start or end with a period (.), and it should not have periods in succession (..).
    
    The name can be up to 256 characters long.
    
    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
  - setMessageAttributeNames
```
public void setMessageAttributeNames(Collection<String> messageAttributeNames)
```
    The name of the message attribute, where N is the index.
    - The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
    - The name is case-sensitive and must be unique among all attribute names for the message.
    - The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    - The name must not start or end with a period (.), and it should not have periods in succession ( ..).
    - The name can be up to 256 characters long.
    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
    Parameters:
    messageAttributeNames - The name of the message attribute, where N is the index.
    
    The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
    
    The name is case-sensitive and must be unique among all attribute names for the message.
    
    The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    
    The name must not start or end with a period (.), and it should not have periods in succession (..).
    
    The name can be up to 256 characters long.
    
    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
  - withMessageAttributeNames
```
public ReceiveMessageRequest withMessageAttributeNames(String... messageAttributeNames)
```
    The name of the message attribute, where N is the index.
    - The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
    - The name is case-sensitive and must be unique among all attribute names for the message.
    - The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    - The name must not start or end with a period (.), and it should not have periods in succession ( ..).
    - The name can be up to 256 characters long.
    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
    
    NOTE: This method appends the values to the existing list (if any). Use setMessageAttributeNames(java.util.Collection) or withMessageAttributeNames(java.util.Collection) if you want to override the existing values.
    Parameters:
    messageAttributeNames - The name of the message attribute, where N is the index.
    
    The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
    
    The name is case-sensitive and must be unique among all attribute names for the message.
    
    The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    
    The name must not start or end with a period (.), and it should not have periods in succession (..).
    
    The name can be up to 256 characters long.
    
    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMessageAttributeNames
```
public ReceiveMessageRequest withMessageAttributeNames(Collection<String> messageAttributeNames)
```
    The name of the message attribute, where N is the index.
    - The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
    - The name is case-sensitive and must be unique among all attribute names for the message.
    - The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    - The name must not start or end with a period (.), and it should not have periods in succession ( ..).
    - The name can be up to 256 characters long.
    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
    Parameters:
    messageAttributeNames - The name of the message attribute, where N is the index.
    
    The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
    
    The name is case-sensitive and must be unique among all attribute names for the message.
    
    The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
    
    The name must not start or end with a period (.), and it should not have periods in succession (..).
    
    The name can be up to 256 characters long.
    
    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxNumberOfMessages
```
public void setMaxNumberOfMessages(Integer maxNumberOfMessages)
```
    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
    
    Parameters:
    
    maxNumberOfMessages - The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
  - getMaxNumberOfMessages
```
public Integer getMaxNumberOfMessages()
```
    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
    
    Returns:
    
    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
  - withMaxNumberOfMessages
```
public ReceiveMessageRequest withMaxNumberOfMessages(Integer maxNumberOfMessages)
```
    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
    
    Parameters:
    
    maxNumberOfMessages - The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVisibilityTimeout
```
public void setVisibilityTimeout(Integer visibilityTimeout)
```
    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
    
    Parameters:
    
    visibilityTimeout - The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
  - getVisibilityTimeout
```
public Integer getVisibilityTimeout()
```
    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
    
    Returns:
    
    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
  - withVisibilityTimeout
```
public ReceiveMessageRequest withVisibilityTimeout(Integer visibilityTimeout)
```
    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
    
    Parameters:
    
    visibilityTimeout - The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWaitTimeSeconds
```
public void setWaitTimeSeconds(Integer waitTimeSeconds)
```
    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
    
    Parameters:
    
    waitTimeSeconds - The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
  - getWaitTimeSeconds
```
public Integer getWaitTimeSeconds()
```
    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
    
    Returns:
    
    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
  - withWaitTimeSeconds
```
public ReceiveMessageRequest withWaitTimeSeconds(Integer waitTimeSeconds)
```
    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
    
    Parameters:
    
    waitTimeSeconds - The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReceiveRequestAttemptId
```
public void setReceiveRequestAttemptId(String receiveRequestAttemptId)
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
    - You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
    - When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
    - If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
    - You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
    - During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
      
      If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
      
      To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
    - While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
    - If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
    The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.
    Parameters:
    receiveRequestAttemptId - This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
    
    You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
    
    When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
    
    If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
    
    You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
    
    During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
    
    If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
    
    To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
    
    While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
    
    If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
    
    The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.
  - getReceiveRequestAttemptId
```
public String getReceiveRequestAttemptId()
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
    - You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
    - When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
    - If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
    - You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
    - During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
      
      If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
      
      To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
    - While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
    - If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
    The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.
    Returns:
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
    
    You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
    
    When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
    
    If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
    
    You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
    
    During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
    
    If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
    
    To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
    
    While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
    
    If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
    
    The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.
  - withReceiveRequestAttemptId
```
public ReceiveMessageRequest withReceiveRequestAttemptId(String receiveRequestAttemptId)
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
    - You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
    - When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
    - If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
    - You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
    - During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
      
      If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
      
      To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
    - While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
    - If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
    The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.
    Parameters:
    receiveRequestAttemptId - This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
    
    You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
    
    When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
    
    If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
    
    You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
    
    During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
    
    If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
    
    To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
    
    While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
    
    If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
    
    The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.
    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 ReceiveMessageRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class ReceiveMessageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ReceiveMessageRequest

ReceiveMessageRequest

Method Detail

setQueueUrl

getQueueUrl

withQueueUrl

getAttributeNames

setAttributeNames

withAttributeNames

withAttributeNames

withAttributeNames

getMessageAttributeNames

setMessageAttributeNames

withMessageAttributeNames

withMessageAttributeNames

setMaxNumberOfMessages

getMaxNumberOfMessages

withMaxNumberOfMessages

setVisibilityTimeout

getVisibilityTimeout

withVisibilityTimeout

setWaitTimeSeconds

getWaitTimeSeconds

withWaitTimeSeconds

setReceiveRequestAttemptId

getReceiveRequestAttemptId

withReceiveRequestAttemptId

toString

equals

hashCode

clone