ReceiveMessageRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sqs.model.SqsRequest
    - - software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ReceiveMessageRequest.Builder,ReceiveMessageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ReceiveMessageRequest
extends SqsRequest
implements ToCopyableBuilder<ReceiveMessageRequest.Builder,ReceiveMessageRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReceiveMessageRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ReceiveMessageRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<QueueAttributeName>`	`attributeNames()` A list of attributes that need to be returned along with each message.
`List<String>`	`attributeNamesAsStrings()` A list of attributes that need to be returned along with each message.
`static ReceiveMessageRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributeNames()` Returns true if the AttributeNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasMessageAttributeNames()` Returns true if the MessageAttributeNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`maxNumberOfMessages()` The maximum number of messages to return.
`List<String>`	`messageAttributeNames()` The name of the message attribute, where N is the index.
`String`	`queueUrl()` The URL of the Amazon SQS queue from which messages are received.
`String`	`receiveRequestAttemptId()` This parameter applies only to FIFO (first-in-first-out) queues.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ReceiveMessageRequest.Builder>`	`serializableBuilderClass()`
`ReceiveMessageRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`visibilityTimeout()` The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a `ReceiveMessage` request.
`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 software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - queueUrl
```
public final String queueUrl()
```
    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.
  - attributeNames
```
public final List<QueueAttributeName> attributeNames()
```
    A list of attributes 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 across all queues but not deleted.
    - AWSTraceHeader – Returns the AWS X-Ray trace header string.
    - 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAttributeNames() to see if a value was sent in this field.
    Returns:
    A list of attributes 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 across all queues but not deleted.
    
    AWSTraceHeader – Returns the AWS X-Ray trace header string.
    
    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.
  - hasAttributeNames
```
public final boolean hasAttributeNames()
```
    Returns true if the AttributeNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - attributeNamesAsStrings
```
public final List<String> attributeNamesAsStrings()
```
    A list of attributes 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 across all queues but not deleted.
    - AWSTraceHeader – Returns the AWS X-Ray trace header string.
    - 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAttributeNames() to see if a value was sent in this field.
    Returns:
    A list of attributes 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 across all queues but not deleted.
    
    AWSTraceHeader – Returns the AWS X-Ray trace header string.
    
    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.
  - hasMessageAttributeNames
```
public final boolean hasMessageAttributeNames()
```
    Returns true if the MessageAttributeNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - messageAttributeNames
```
public final List<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.*.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasMessageAttributeNames() to see if a value was sent in this field.
    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.*.
  - maxNumberOfMessages
```
public final 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.
    
    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.
  - visibilityTimeout
```
public final Integer visibilityTimeout()
```
    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.
  - waitTimeSeconds
```
public final 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.
    
    To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage requests is longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
    
    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.
    
    To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage requests is longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
  - receiveRequestAttemptId
```
public final 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, it is possible to 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.
    - It is possible to 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 maximum 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, it is possible to 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.
    
    It is possible to 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 maximum 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.
  - toBuilder
```
public ReceiveMessageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReceiveMessageRequest.Builder,ReceiveMessageRequest>
    
    Specified by:
    
    toBuilder in class SqsRequest
  - builder
```
public static ReceiveMessageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReceiveMessageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ReceiveMessageRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

queueUrl

attributeNames

hasAttributeNames

attributeNamesAsStrings

hasMessageAttributeNames

messageAttributeNames

maxNumberOfMessages

visibilityTimeout

waitTimeSeconds

receiveRequestAttemptId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields