Package software.amazon.awssdk.services.sqs.batchmanager

Interface SqsAsyncBatchManager

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

All Known Implementing Classes:

DefaultSqsAsyncBatchManager

@SdkPublicApi
public interface SqsAsyncBatchManager
extends SdkAutoCloseable

Batch manager for implementing automatic batching with an SQS async client. Create an instance using builder().

This manager buffers client requests and sends them in batches to the service, enhancing efficiency by reducing the number of API requests. Requests are buffered until they reach a specified limit or a timeout occurs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SqsAsyncBatchManager.Builder

Method Summary

Modifier and Type	Method	Description
static SqsAsyncBatchManager.Builder	builder()	Creates a builder for configuring and creating an SqsAsyncBatchManager.
default CompletableFuture<ChangeMessageVisibilityResponse>	changeMessageVisibility(Consumer<ChangeMessageVisibilityRequest.Builder> request)	Buffers and batches ChangeMessageVisibilityRequests using a Consumer to configure the request, sending them as a ChangeMessageVisibilityBatchRequest.
default CompletableFuture<ChangeMessageVisibilityResponse>	changeMessageVisibility(ChangeMessageVisibilityRequest request)	Buffers and batches ChangeMessageVisibilityRequests, sending them as a ChangeMessageVisibilityBatchRequest.
default CompletableFuture<DeleteMessageResponse>	deleteMessage(Consumer<DeleteMessageRequest.Builder> request)	Buffers and batches DeleteMessageRequests using a Consumer to configure the request, sending them as a DeleteMessageBatchRequest.
default CompletableFuture<DeleteMessageResponse>	deleteMessage(DeleteMessageRequest request)	Buffers and batches DeleteMessageRequests, sending them as a DeleteMessageBatchRequest.
default CompletableFuture<ReceiveMessageResponse>	receiveMessage(Consumer<ReceiveMessageRequest.Builder> request)	Buffers and retrieves messages with ReceiveMessageRequest using a Consumer to configure the request, with a maximum of 10 messages per request.
default CompletableFuture<ReceiveMessageResponse>	receiveMessage(ReceiveMessageRequest request)	Buffers and retrieves messages with ReceiveMessageRequest, with a maximum of 10 messages per request.
default CompletableFuture<SendMessageResponse>	sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest)	Buffers and batches SendMessageRequests using a Consumer to configure the request, sending them as a SendMessageBatchRequest.
default CompletableFuture<SendMessageResponse>	sendMessage(SendMessageRequest request)	Buffers and batches SendMessageRequests, sending them as a SendMessageBatchRequest.

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

close

Method Detail

builder

static SqsAsyncBatchManager.Builder builder()

Creates a builder for configuring and creating an SqsAsyncBatchManager.

Returns:

A new builder.

sendMessage

default CompletableFuture<SendMessageResponse> sendMessage(SendMessageRequest request)

Buffers and batches SendMessageRequests, sending them as a SendMessageBatchRequest. Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.

Parameters:

request - The SendMessageRequest to be buffered.

Returns:

CompletableFuture of the corresponding SendMessageResponse.

sendMessage

default CompletableFuture<SendMessageResponse> sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest)

Buffers and batches SendMessageRequests using a Consumer to configure the request, sending them as a SendMessageBatchRequest. Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.

Parameters:

sendMessageRequest - A Consumer to configure the SendMessageRequest to be buffered.

Returns:

CompletableFuture of the corresponding SendMessageResponse.

deleteMessage

default CompletableFuture<DeleteMessageResponse> deleteMessage(DeleteMessageRequest request)

Buffers and batches DeleteMessageRequests, sending them as a DeleteMessageBatchRequest. Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.

Parameters:

request - The DeleteMessageRequest to be buffered.

Returns:

CompletableFuture of the corresponding DeleteMessageResponse.

deleteMessage

default CompletableFuture<DeleteMessageResponse> deleteMessage(Consumer<DeleteMessageRequest.Builder> request)

Buffers and batches DeleteMessageRequests using a Consumer to configure the request, sending them as a DeleteMessageBatchRequest. Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.

Parameters:

request - A Consumer to configure the DeleteMessageRequest to be buffered.

Returns:

CompletableFuture of the corresponding DeleteMessageResponse.

changeMessageVisibility

default CompletableFuture<ChangeMessageVisibilityResponse> changeMessageVisibility(ChangeMessageVisibilityRequest request)

Buffers and batches ChangeMessageVisibilityRequests, sending them as a ChangeMessageVisibilityBatchRequest. Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.

Parameters:

request - The ChangeMessageVisibilityRequest to be buffered.

Returns:

CompletableFuture of the corresponding ChangeMessageVisibilityResponse.

changeMessageVisibility

default CompletableFuture<ChangeMessageVisibilityResponse> changeMessageVisibility(Consumer<ChangeMessageVisibilityRequest.Builder> request)

Buffers and batches ChangeMessageVisibilityRequests using a Consumer to configure the request, sending them as a ChangeMessageVisibilityBatchRequest. Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.

Parameters:

request - A Consumer to configure the ChangeMessageVisibilityRequest to be buffered.

Returns:

CompletableFuture of the corresponding ChangeMessageVisibilityResponse.

receiveMessage

default CompletableFuture<ReceiveMessageResponse> receiveMessage(ReceiveMessageRequest request)

Buffers and retrieves messages with ReceiveMessageRequest, with a maximum of 10 messages per request. Returns an empty message if no messages are available in SQS.

Parameters:

request - The ReceiveMessageRequest.

Returns:

CompletableFuture of the corresponding ReceiveMessageResponse.

receiveMessage

default CompletableFuture<ReceiveMessageResponse> receiveMessage(Consumer<ReceiveMessageRequest.Builder> request)

Buffers and retrieves messages with ReceiveMessageRequest using a Consumer to configure the request, with a maximum of 10 messages per request. Returns an empty message if no messages are available in SQS.

Parameters:

request - A Consumer to configure the ReceiveMessageRequest.

Returns:

CompletableFuture of the corresponding ReceiveMessageResponse.