Package io.awspring.cloud.sqs.operations

Interface SqsOperations

All Superinterfaces:

MessagingOperations

All Known Implementing Classes:

SqsTemplate

public interface SqsOperations
extends MessagingOperations

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

Since:

3.0

Author:

Tomaz Fernandes

Method Summary

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

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

receive, receive, receiveMany, receiveMany, send, send, send, sendMany

Method Details

send

<T> SendResult<T> send(Consumer<SqsSendOptions<T>> to)

Send a message using the SqsSendOptions options.

Parameters:

to - a SqsSendOptions consumer.

Returns:

The UUID of the message.

receive

Optional<Message<?>> receive(Consumer<SqsReceiveOptions> from)

Receive a message using SqsReceiveOptions.

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

The message, or an empty collection if none is returned.

receive

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

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

Parameters:

from - a SqsReceiveOptions consumer.

payloadClass - to class to convert the payload to.

Returns:

The message, or an empty collection if none is returned.

receiveMany

Collection<Message<?>> receiveMany(Consumer<SqsReceiveOptions> from)

Receive a batch of messages using SqsReceiveOptions.

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

The message, or an empty collection if none is returned.

receiveMany

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

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

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

The message, or an empty collection if none is returned.