Package com.amazon.sqs.javamessaging

Class AmazonSQSExtendedAsyncClient

java.lang.Object
com.amazon.sqs.javamessaging.AmazonSQSExtendedAsyncClient
All Implemented Interfaces:
AutoCloseable, software.amazon.awssdk.awscore.AwsClient, software.amazon.awssdk.core.SdkClient, software.amazon.awssdk.services.sqs.SqsAsyncClient, software.amazon.awssdk.utils.SdkAutoCloseable
public class AmazonSQSExtendedAsyncClient extends Object implements software.amazon.awssdk.services.sqs.SqsAsyncClient
Amazon SQS Extended Async Client extends the functionality of Amazon Async SQS client.

All service calls made using this client are asynchronous, and will return immediately with a CompletableFuture that completes when the operation completes or when an exception is thrown. Argument validation exceptions are thrown immediately, and not through the future.

The Amazon SQS extended client enables sending and receiving large messages via Amazon S3. You can use this library to:

  • Specify whether messages are always stored in Amazon S3 or only when a message size exceeds 256 KB.
  • Send a message that references a single message object stored in an Amazon S3 bucket.
  • Get the corresponding message object from an Amazon S3 bucket.
  • Delete the corresponding message object from an Amazon S3 bucket.

  • Field Summary

    Fields inherited from interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    SERVICE_METADATA_ID, SERVICE_NAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    AmazonSQSExtendedAsyncClient(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsClient)
    Constructs a new Amazon SQS extended async client to invoke service methods on Amazon SQS with extended functionality using the specified Amazon SQS client object.
    AmazonSQSExtendedAsyncClient(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsClient, ExtendedAsyncClientConfiguration extendedClientConfig)
    Constructs a new Amazon SQS extended client to invoke service methods on Amazon SQS with extended functionality using the specified Amazon SQS client object.

  • Method Summary

    Modifier and Type
    Method
    Description
    CompletableFuture<software.amazon.awssdk.services.sqs.model.AddPermissionResponse>
    addPermission(software.amazon.awssdk.services.sqs.model.AddPermissionRequest addPermissionRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityResponse>
    changeMessageVisibility(software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchResponse>
    changeMessageVisibilityBatch(software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
    void
    close()
    CompletableFuture<software.amazon.awssdk.services.sqs.model.CreateQueueResponse>
    createQueue(software.amazon.awssdk.services.sqs.model.CreateQueueRequest createQueueRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.DeleteMessageResponse>
    deleteMessage(software.amazon.awssdk.services.sqs.model.DeleteMessageRequest deleteMessageRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResponse>
    deleteMessageBatch(software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequest deleteMessageBatchRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.DeleteQueueResponse>
    deleteQueue(software.amazon.awssdk.services.sqs.model.DeleteQueueRequest deleteQueueRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.GetQueueAttributesResponse>
    getQueueAttributes(software.amazon.awssdk.services.sqs.model.GetQueueAttributesRequest getQueueAttributesRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.GetQueueUrlResponse>
    getQueueUrl(software.amazon.awssdk.services.sqs.model.GetQueueUrlRequest getQueueUrlRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesResponse>
    listDeadLetterSourceQueues(software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.ListQueuesResponse>
    listQueues()
    CompletableFuture<software.amazon.awssdk.services.sqs.model.ListQueuesResponse>
    listQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest listQueuesRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.ListQueueTagsResponse>
    listQueueTags(software.amazon.awssdk.services.sqs.model.ListQueueTagsRequest listQueueTagsRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.PurgeQueueResponse>
    purgeQueue(software.amazon.awssdk.services.sqs.model.PurgeQueueRequest purgeQueueRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse>
    receiveMessage(software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest receiveMessageRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.RemovePermissionResponse>
    removePermission(software.amazon.awssdk.services.sqs.model.RemovePermissionRequest removePermissionRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.SendMessageResponse>
    sendMessage(software.amazon.awssdk.services.sqs.model.SendMessageRequest sendMessageRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.SendMessageBatchResponse>
    sendMessageBatch(software.amazon.awssdk.services.sqs.model.SendMessageBatchRequest sendMessageBatchRequestIn)
    String
    serviceName()
    CompletableFuture<software.amazon.awssdk.services.sqs.model.SetQueueAttributesResponse>
    setQueueAttributes(software.amazon.awssdk.services.sqs.model.SetQueueAttributesRequest setQueueAttributesRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.TagQueueResponse>
    tagQueue(software.amazon.awssdk.services.sqs.model.TagQueueRequest tagQueueRequest)
    CompletableFuture<software.amazon.awssdk.services.sqs.model.UntagQueueResponse>
    untagQueue(software.amazon.awssdk.services.sqs.model.UntagQueueRequest untagQueueRequest)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

    close

    Methods inherited from interface software.amazon.awssdk.core.SdkClient

    serviceName

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

    addPermission, addPermission, cancelMessageMoveTask, cancelMessageMoveTask, changeMessageVisibility, changeMessageVisibilityBatch, createQueue, createQueue, deleteMessage, deleteMessageBatch, deleteQueue, deleteQueue, getQueueAttributes, getQueueAttributes, getQueueUrl, getQueueUrl, listDeadLetterSourceQueues, listDeadLetterSourceQueues, listDeadLetterSourceQueuesPaginator, listDeadLetterSourceQueuesPaginator, listMessageMoveTasks, listMessageMoveTasks, listQueues, listQueues, listQueues, listQueuesPaginator, listQueuesPaginator, listQueuesPaginator, listQueueTags, listQueueTags, purgeQueue, receiveMessage, removePermission, removePermission, sendMessage, sendMessageBatch, serviceClientConfiguration, setQueueAttributes, setQueueAttributes, startMessageMoveTask, startMessageMoveTask, tagQueue, tagQueue, untagQueue, untagQueue

  • Constructor Details

    • AmazonSQSExtendedAsyncClient

      public AmazonSQSExtendedAsyncClient(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsClient)
      Constructs a new Amazon SQS extended async client to invoke service methods on Amazon SQS with extended functionality using the specified Amazon SQS client object.

      All service calls made using this client are asynchronous, and will return immediately with a CompletableFuture that completes when the operation completes or when an exception is thrown. Argument validation exceptions are thrown immediately, and not through the future.

      Parameters:
      sqsClient - The Amazon SQS async client to use to connect to Amazon SQS.

    • AmazonSQSExtendedAsyncClient

      public AmazonSQSExtendedAsyncClient(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsClient, ExtendedAsyncClientConfiguration extendedClientConfig)
      Constructs a new Amazon SQS extended client to invoke service methods on Amazon SQS with extended functionality using the specified Amazon SQS client object.

      All service calls made using this client are asynchronous, and will return immediately with a CompletableFuture that completes when the operation completes or when an exception is thrown. Argument validation exceptions are thrown immediately, and not through the future.

      Parameters:
      sqsClient - The Amazon SQS async client to use to connect to Amazon SQS.
      extendedClientConfig - The extended client configuration options controlling the functionality of this client.

  • Method Details

    • sendMessage

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.SendMessageResponse> sendMessage(software.amazon.awssdk.services.sqs.model.SendMessageRequest sendMessageRequest)
      Specified by:
      sendMessage in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • receiveMessage

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse> receiveMessage(software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest receiveMessageRequest)
      Specified by:
      receiveMessage in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • deleteMessage

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.DeleteMessageResponse> deleteMessage(software.amazon.awssdk.services.sqs.model.DeleteMessageRequest deleteMessageRequest)
      Specified by:
      deleteMessage in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • changeMessageVisibility

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityResponse> changeMessageVisibility(software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
      Specified by:
      changeMessageVisibility in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • sendMessageBatch

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.SendMessageBatchResponse> sendMessageBatch(software.amazon.awssdk.services.sqs.model.SendMessageBatchRequest sendMessageBatchRequestIn)
      Specified by:
      sendMessageBatch in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • deleteMessageBatch

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResponse> deleteMessageBatch(software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequest deleteMessageBatchRequest)
      Specified by:
      deleteMessageBatch in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • changeMessageVisibilityBatch

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchResponse> changeMessageVisibilityBatch(software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
      Specified by:
      changeMessageVisibilityBatch in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • purgeQueue

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.PurgeQueueResponse> purgeQueue(software.amazon.awssdk.services.sqs.model.PurgeQueueRequest purgeQueueRequest)
      Specified by:
      purgeQueue in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • setQueueAttributes

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.SetQueueAttributesResponse> setQueueAttributes(software.amazon.awssdk.services.sqs.model.SetQueueAttributesRequest setQueueAttributesRequest)
      Specified by:
      setQueueAttributes in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • getQueueUrl

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.GetQueueUrlResponse> getQueueUrl(software.amazon.awssdk.services.sqs.model.GetQueueUrlRequest getQueueUrlRequest)
      Specified by:
      getQueueUrl in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • removePermission

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.RemovePermissionResponse> removePermission(software.amazon.awssdk.services.sqs.model.RemovePermissionRequest removePermissionRequest)
      Specified by:
      removePermission in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • getQueueAttributes

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.GetQueueAttributesResponse> getQueueAttributes(software.amazon.awssdk.services.sqs.model.GetQueueAttributesRequest getQueueAttributesRequest)
      Specified by:
      getQueueAttributes in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • listDeadLetterSourceQueues

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesResponse> listDeadLetterSourceQueues(software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
      Specified by:
      listDeadLetterSourceQueues in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • deleteQueue

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.DeleteQueueResponse> deleteQueue(software.amazon.awssdk.services.sqs.model.DeleteQueueRequest deleteQueueRequest)
      Specified by:
      deleteQueue in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • listQueues

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.ListQueuesResponse> listQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest listQueuesRequest)
      Specified by:
      listQueues in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • listQueues

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.ListQueuesResponse> listQueues()
      Specified by:
      listQueues in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • createQueue

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.CreateQueueResponse> createQueue(software.amazon.awssdk.services.sqs.model.CreateQueueRequest createQueueRequest)
      Specified by:
      createQueue in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • addPermission

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.AddPermissionResponse> addPermission(software.amazon.awssdk.services.sqs.model.AddPermissionRequest addPermissionRequest)
      Specified by:
      addPermission in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • listQueueTags

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.ListQueueTagsResponse> listQueueTags(software.amazon.awssdk.services.sqs.model.ListQueueTagsRequest listQueueTagsRequest)
      Specified by:
      listQueueTags in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • tagQueue

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.TagQueueResponse> tagQueue(software.amazon.awssdk.services.sqs.model.TagQueueRequest tagQueueRequest)
      Specified by:
      tagQueue in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • untagQueue

      public CompletableFuture<software.amazon.awssdk.services.sqs.model.UntagQueueResponse> untagQueue(software.amazon.awssdk.services.sqs.model.UntagQueueRequest untagQueueRequest)
      Specified by:
      untagQueue in interface software.amazon.awssdk.services.sqs.SqsAsyncClient

    • serviceName

      public String serviceName()
      Specified by:
      serviceName in interface software.amazon.awssdk.core.SdkClient

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface software.amazon.awssdk.utils.SdkAutoCloseable