SqsBufferedAsyncClient (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.sqs.buffered.SqsBufferedAsyncClient

All Implemented Interfaces:

AutoCloseable, SQSAsyncClient
```
public class SqsBufferedAsyncClient
extends Object
implements SQSAsyncClient
```
AmazonSQSBufferedAsyncClient provides client-side batching of outgoing sendMessage, deleteMessage and changeMessageVisibility calls.
After receiving a call, rather than executing it right away, this client waits for a configurable period of time ( default=200ms) for other calls of the same type to come in; if such calls do come in, they are also not executed immediately, but instead are added to the batch. When the batch becomes full or the timeout period expires, the entire batch is executed at once and the results are returned to the callers. This method of operation leads to reduced operating costs (since SQS charges per call and fewer calls are made) and increased overall throughput (since more work is performed per call, and all fixed costs of making a call are amortized over a greater amount of work). The cost of this method is increased latency for individual calls, since calls spend some time waiting on the client side for the potential batch-mates to appear before they are actually executed.
This client also performs pre-fetching of messages from SQS. After the first receiveMessage call is made, the client attempts not only to satisfy that call, but also pre-fetch extra messages to store in a temporary buffer. Future receiveMessage calls will be satisfied from the buffer, and only if the buffer is empty will the calling thread have to wait for the messages to be fetched. The size of the buffer and the maximum number of threads used for prefetching are configurable.
AmazonSQSBufferedAsyncClient is thread-safe.

Field Summary

Fields
Modifier and Type Field Description

static String USER_AGENT

Fields
Modifier and Type	Field	Description
`static String`	`USER_AGENT`

Constructor Summary

Constructors
Constructor	Description
`SqsBufferedAsyncClient(SQSAsyncClient paramRealSqs)`
`SqsBufferedAsyncClient(SQSAsyncClient paramRealSqs, QueueBufferConfig config)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CompletableFuture<AddPermissionResponse>`	`addPermission(AddPermissionRequest addPermissionRequest)`	Adds a permission to a queue for a specific principal.
`CompletableFuture<ChangeMessageVisibilityResponse>`	`changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)`	Changes the visibility timeout of a specified message in a queue to a new value.
`CompletableFuture<ChangeMessageVisibilityBatchResponse>`	`changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)`	Changes the visibility timeout of multiple messages.
`void`	`close()`
`CompletableFuture<CreateQueueResponse>`	`createQueue(CreateQueueRequest createQueueRequest)`	Creates a new standard or FIFO queue.
`CompletableFuture<DeleteMessageResponse>`	`deleteMessage(DeleteMessageRequest deleteMessageRequest)`	Deletes the specified message from the specified queue.
`CompletableFuture<DeleteMessageBatchResponse>`	`deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)`	Deletes up to ten messages from the specified queue.
`CompletableFuture<DeleteQueueResponse>`	`deleteQueue(DeleteQueueRequest deleteQueueRequest)`	Deletes the queue specified by the `QueueUrl`, even if the queue is empty.
`CompletableFuture<GetQueueAttributesResponse>`	`getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)`	Gets attributes for the specified queue.
`CompletableFuture<GetQueueUrlResponse>`	`getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)`	Returns the URL of an existing queue.
`CompletableFuture<ListDeadLetterSourceQueuesResponse>`	`listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)`	Returns a list of your queues that have the `RedrivePolicy` queue attribute configured with a dead letter queue.
`CompletableFuture<ListQueuesResponse>`	`listQueues(ListQueuesRequest listQueuesRequest)`	Returns a list of your queues.
`CompletableFuture<PurgeQueueResponse>`	`purgeQueue(PurgeQueueRequest purgeQueueRequest)`	Deletes the messages in a queue specified by the `QueueURL` parameter.
`CompletableFuture<ReceiveMessageResponse>`	`receiveMessage(ReceiveMessageRequest receiveMessageRequest)`	Retrieves one or more messages (up to 10), from the specified queue.
`CompletableFuture<RemovePermissionResponse>`	`removePermission(RemovePermissionRequest removePermissionRequest)`	Revokes any permissions in the queue policy that matches the specified `Label` parameter.
`CompletableFuture<SendMessageResponse>`	`sendMessage(SendMessageRequest sendMessageRequest)`	Delivers a message to the specified queue.
`CompletableFuture<SendMessageBatchResponse>`	`sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)`	Delivers up to ten messages to the specified queue.
`CompletableFuture<SetQueueAttributesResponse>`	`setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)`	Sets the value of one or more queue attributes.

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

Methods inherited from interface software.amazon.awssdk.services.sqs.SQSAsyncClient
builder, create

- Field Detail
  - USER_AGENT
```
public static final String USER_AGENT
```
- Constructor Detail
  - SqsBufferedAsyncClient
```
public SqsBufferedAsyncClient(SQSAsyncClient paramRealSqs)
```
  - SqsBufferedAsyncClient
```
public SqsBufferedAsyncClient(SQSAsyncClient paramRealSqs,
                              QueueBufferConfig config)
```
- Method Detail
  - addPermission
```
public CompletableFuture<AddPermissionResponse> addPermission(AddPermissionRequest addPermissionRequest)
```
    Description copied from interface: SQSAsyncClient
    
    Adds a permission to a queue for a specific principal. This allows sharing access to the queue.
    
    When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
    
    AddPermission writes an Amazon-SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.
    
    Some 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
    Specified by:
    
    addPermission in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the AddPermission operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    OverLimitException The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached. AddPermission returns this error if the maximum number of permissions for the queue is reached.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    See Also:
    
    AWS API Documentation
  - createQueue
```
public CompletableFuture<CreateQueueResponse> createQueue(CreateQueueRequest createQueueRequest)
```
    Description copied from interface: SQSAsyncClient
    Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind:
    - If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
      
      You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon SQS Developer Guide.
    - If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
    - If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
    To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
    
    To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:
    - If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
    - If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.
    Some 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
    Specified by:
    
    createQueue in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the CreateQueue operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    QueueDeletedRecentlyException You must wait 60 seconds after deleting a queue before you can create another one with the same name.
    
    QueueNameExistsException A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    See Also:
    
    AWS API Documentation
  - deleteQueue
```
public CompletableFuture<DeleteQueueResponse> deleteQueue(DeleteQueueRequest deleteQueueRequest)
```
    Description copied from interface: SQSAsyncClient
    
    Deletes the queue specified by the QueueUrl, even if the queue is empty. If the specified queue doesn't exist, Amazon SQS returns a successful response.
    
    Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.
    
    When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
    
    When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
    
    Specified by:
    
    deleteQueue in interface SQSAsyncClient
    
    Returns:
    
    A Java Future containing the result of the DeleteQueue operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getQueueAttributes
```
public CompletableFuture<GetQueueAttributesResponse> getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
```
    Description copied from interface: SQSAsyncClient
    
    Gets attributes for the specified queue.
    
    To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
    
    Some 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
    Specified by:
    
    getQueueAttributes in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the GetQueueAttributes operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    InvalidAttributeNameException The attribute referred to doesn't exist.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    See Also:
    
    AWS API Documentation
  - getQueueUrl
```
public CompletableFuture<GetQueueUrlResponse> getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
```
    Description copied from interface: SQSAsyncClient
    
    Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.
    
    To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Shared Queues in the Amazon SQS Developer Guide.
    Specified by:
    
    getQueueUrl in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the GetQueueUrl operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    QueueDoesNotExistException The queue referred to doesn't exist.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    See Also:
    
    AWS API Documentation
  - listQueues
```
public CompletableFuture<ListQueuesResponse> listQueues(ListQueuesRequest listQueuesRequest)
```
    Description copied from interface: SQSAsyncClient
    
    Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
    
    Specified by:
    
    listQueues in interface SQSAsyncClient
    
    Returns:
    
    A Java Future containing the result of the ListQueues operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - purgeQueue
```
public CompletableFuture<PurgeQueueResponse> purgeQueue(PurgeQueueRequest purgeQueueRequest)
```
    Description copied from interface: SQSAsyncClient
    
    Deletes the messages in a queue specified by the QueueURL parameter.
    
    When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.
    
    When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.
    Specified by:
    
    purgeQueue in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the PurgeQueue operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    QueueDoesNotExistException The queue referred to doesn't exist.
    
    PurgeQueueInProgressException Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    See Also:
    
    AWS API Documentation
  - removePermission
```
public CompletableFuture<RemovePermissionResponse> removePermission(RemovePermissionRequest removePermissionRequest)
```
    Description copied from interface: SQSAsyncClient
    
    Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.
    
    Specified by:
    
    removePermission in interface SQSAsyncClient
    
    Returns:
    
    A Java Future containing the result of the RemovePermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setQueueAttributes
```
public CompletableFuture<SetQueueAttributesResponse> setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
                                                                 throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    
    Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.
    
    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
    Specified by:
    
    setQueueAttributes in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the SetQueueAttributes operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    InvalidAttributeNameException The attribute referred to doesn't exist.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - changeMessageVisibilityBatch
```
public CompletableFuture<ChangeMessageVisibilityBatchResponse> changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                                     throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    
    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.
    
    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.
    
    Some 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
    Specified by:
    
    changeMessageVisibilityBatch in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the ChangeMessageVisibilityBatch operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    TooManyEntriesInBatchRequestException The batch request contains more entries than permissible.
    
    EmptyBatchRequestException The batch request doesn't contain any entries.
    
    BatchEntryIdsNotDistinctException Two or more batch entries in the request have the same Id.
    
    InvalidBatchEntryIdException The Id of a batch entry in a batch request doesn't abide by the specification.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - changeMessageVisibility
```
public CompletableFuture<ChangeMessageVisibilityResponse> changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                                                                           throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    
    Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.
    
    For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.
    
    A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.
    
    For standard queues, there can be a maximum of 120,000 inflight messages per queue. If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
    
    For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages.
    
    If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
    
    Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.
    Specified by:
    
    changeMessageVisibility in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the ChangeMessageVisibility operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    MessageNotInflightException The message referred to isn't in flight.
    
    ReceiptHandleIsInvalidException The receipt handle provided isn't valid.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - sendMessageBatch
```
public CompletableFuture<SendMessageBatchResponse> sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
                                                             throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    
    Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
    
    The result of sending each message is reported individually in the response. 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.
    
    The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
    
    If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
    
    Some 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
    Specified by:
    
    sendMessageBatch in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the SendMessageBatch operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    TooManyEntriesInBatchRequestException The batch request contains more entries than permissible.
    
    EmptyBatchRequestException The batch request doesn't contain any entries.
    
    BatchEntryIdsNotDistinctException Two or more batch entries in the request have the same Id.
    
    BatchRequestTooLongException The length of all the messages put together is more than the limit.
    
    InvalidBatchEntryIdException The Id of a batch entry in a batch request doesn't abide by the specification.
    
    UnsupportedOperationException Error code 400. Unsupported operation.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - sendMessage
```
public CompletableFuture<SendMessageResponse> sendMessage(SendMessageRequest sendMessageRequest)
                                                   throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    
    Delivers a message to the specified queue.
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
    Specified by:
    
    sendMessage in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the SendMessage operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    InvalidMessageContentsException The message contains characters outside the allowed set.
    
    UnsupportedOperationException Error code 400. Unsupported operation.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - receiveMessage
```
public CompletableFuture<ReceiveMessageResponse> receiveMessage(ReceiveMessageRequest receiveMessageRequest)
                                                         throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.
    
    Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
    
    For each message returned, the response includes the following:
    - The message body.
    - An MD5 digest of the message body. For information about MD5, see RFC1321.
    - The MessageId you received when you sent the message to the queue.
    - The receipt handle.
    - The message attributes.
    - An MD5 digest of the message attributes.
    The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
    
    You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
    
    A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead letter queue.
    
    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
    Specified by:
    
    receiveMessage in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the ReceiveMessage operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    OverLimitException The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached. AddPermission returns this error if the maximum number of permissions for the queue is reached.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - deleteMessageBatch
```
public CompletableFuture<DeleteMessageBatchResponse> deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                                                 throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    
    Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response.
    
    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.
    
    Some 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
    Specified by:
    
    deleteMessageBatch in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the DeleteMessageBatch operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    TooManyEntriesInBatchRequestException The batch request contains more entries than permissible.
    
    EmptyBatchRequestException The batch request doesn't contain any entries.
    
    BatchEntryIdsNotDistinctException Two or more batch entries in the request have the same Id.
    
    InvalidBatchEntryIdException The Id of a batch entry in a batch request doesn't abide by the specification.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - deleteMessage
```
public CompletableFuture<DeleteMessageResponse> deleteMessage(DeleteMessageRequest deleteMessageRequest)
                                                       throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    
    Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.
    
    The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.
    
    For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
    Specified by:
    
    deleteMessage in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the DeleteMessage operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    InvalidIdFormatException The receipt handle isn't valid for the current version.
    
    ReceiptHandleIsInvalidException The receipt handle provided isn't valid.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - listDeadLetterSourceQueues
```
public CompletableFuture<ListDeadLetterSourceQueuesResponse> listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
                                                                                 throws AmazonClientException
```
    Description copied from interface: SQSAsyncClient
    
    Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
    
    For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.
    Specified by:
    
    listDeadLetterSourceQueues in interface SQSAsyncClient
    
    Returns:
    A Java Future containing the result of the ListDeadLetterSourceQueues operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    QueueDoesNotExistException The queue referred to doesn't exist.
    
    SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
    
    SQSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this
    Throws:
    
    AmazonClientException
    
    See Also:
    
    AWS API Documentation
  - close
```
public void close()
           throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception

Class SqsBufferedAsyncClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.services.sqs.SQSAsyncClient

Field Detail

USER_AGENT

Constructor Detail

SqsBufferedAsyncClient

SqsBufferedAsyncClient

Method Detail

addPermission

createQueue

deleteQueue

getQueueAttributes

getQueueUrl

listQueues

purgeQueue

removePermission

setQueueAttributes

changeMessageVisibilityBatch

changeMessageVisibility

sendMessageBatch

sendMessage

receiveMessage

deleteMessageBatch

deleteMessage

listDeadLetterSourceQueues

close