Package io.awspring.cloud.sqs.operations

Interface SqsAsyncOperations

All Superinterfaces:

AsyncMessagingOperations

All Known Implementing Classes:

SqsTemplate

public interface SqsAsyncOperations
extends AsyncMessagingOperations

Sqs-specific asynchronous messaging operations for Standard and Fifo queues.

Since:

3.0

Author:

Tomaz Fernandes

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Optional<Message<?>>>	receiveAsync(Consumer<SqsReceiveOptions> from)	Receive a message using the SqsReceiveOptions options.
<T> CompletableFuture<Optional<Message<T>>>	receiveAsync(Consumer<SqsReceiveOptions> from, Class<T> payloadClass)	Receive a message using the SqsReceiveOptions options and convert the payload to the provided class.
CompletableFuture<Collection<Message<?>>>	receiveManyAsync(Consumer<SqsReceiveOptions> from)	Receive a batch of messages using the SqsReceiveOptions options.
<T> CompletableFuture<Collection<Message<T>>>	receiveManyAsync(Consumer<SqsReceiveOptions> from, Class<T> payloadClass)	Receive a batch of messages using the SqsReceiveOptions options and convert the payloads to the provided class.
<T> CompletableFuture<SendResult<T>>	sendAsync(Consumer<SqsSendOptions<T>> to)	Send a message using SqsSendOptions.

Methods inherited from interface io.awspring.cloud.sqs.operations.AsyncMessagingOperations

receiveAsync, receiveAsync, receiveManyAsync, receiveManyAsync, sendAsync, sendAsync, sendAsync, sendManyAsync

Method Details

sendAsync

<T> CompletableFuture<SendResult<T>> sendAsync(Consumer<SqsSendOptions<T>> to)

Send a message using SqsSendOptions.

Parameters:

to - a SqsSendOptions consumer.

Returns:

a CompletableFuture to be completed with the UUID of the message.

receiveAsync

CompletableFuture<Optional<Message<?>>> receiveAsync(Consumer<SqsReceiveOptions> from)

Receive a message using the SqsReceiveOptions options.

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

a CompletableFuture to be completed with the message, or Optional.empty() if none is returned.

receiveAsync

<T> CompletableFuture<Optional<Message<T>>> receiveAsync(Consumer<SqsReceiveOptions> from,
 Class<T> payloadClass)

Receive a message using the SqsReceiveOptions options and convert the payload to the provided class.

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

a CompletableFuture to be completed with the message, or Optional.empty() if none is returned.

receiveManyAsync

CompletableFuture<Collection<Message<?>>> receiveManyAsync(Consumer<SqsReceiveOptions> from)

Receive a batch of messages using the SqsReceiveOptions options.

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

a CompletableFuture to be completed with the messages, or an empty collection if none is returned.

receiveManyAsync

<T> CompletableFuture<Collection<Message<T>>> receiveManyAsync(Consumer<SqsReceiveOptions> from,
 Class<T> payloadClass)

Receive a batch of messages using the SqsReceiveOptions options and convert the payloads to the provided class.

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

a CompletableFuture to be completed with the messages, or an empty collection if none is returned.