Package io.awspring.cloud.sqs.listener

Class QueueMessageVisibility

java.lang.Object

io.awspring.cloud.sqs.listener.QueueMessageVisibility

All Implemented Interfaces:

Visibility

public class QueueMessageVisibility
extends Object
implements Visibility

Visibility implementation for SQS messages.

Since:

1.3

Author:

Szymon Dembek, Tomaz Fernandes

Constructor Summary

Constructors

Constructor	Description
QueueMessageVisibility(software.amazon.awssdk.services.sqs.SqsAsyncClient amazonSqsAsync, String queueUrl, String receiptHandle)	Create an instance for changing the visibility for the provided queue.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	changeToAsync(int seconds)	Asynchronously changes the message visibility to the provided value.
BatchVisibility	toBatchVisibility(Collection<Message<?>> messages)	Create a BatchVisibility instance with the provided messages' receipt handlers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.awspring.cloud.sqs.listener.Visibility

changeTo

Constructor Details

QueueMessageVisibility

public QueueMessageVisibility(software.amazon.awssdk.services.sqs.SqsAsyncClient amazonSqsAsync,
 String queueUrl,
 String receiptHandle)

Create an instance for changing the visibility for the provided queue.

Parameters:

amazonSqsAsync - the client to be used.

queueUrl - the queue url.

receiptHandle - the message receipt handle.

Method Details

toBatchVisibility

public BatchVisibility toBatchVisibility(Collection<Message<?>> messages)

Create a BatchVisibility instance with the provided messages' receipt handlers.

Parameters:

messages - the messages to populate the BatchVisibility instance.

Returns:

BatchVisibility instance.

changeToAsync

public CompletableFuture<Void> changeToAsync(int seconds)

Description copied from interface: Visibility

Asynchronously changes the message visibility to the provided value.

Specified by:

changeToAsync in interface Visibility

Parameters:

seconds - number of seconds to set the visibility of the message to.

Returns:

a completable future.