Package io.awspring.cloud.sqs.listener

Interface SqsContainerOptionsBuilder

All Superinterfaces:

ContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions>

public interface SqsContainerOptionsBuilder
extends ContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions>

ContainerOptionsBuilder specialization for SQS specific options.

Since:

3.0

Author:

Tomaz Fernandes

Method Summary

Modifier and Type	Method	Description
SqsContainerOptionsBuilder	fifoBatchGroupingStrategy(FifoBatchGroupingStrategy fifoBatchGroupingStrategy)	Set how the messages from FIFO queues should be grouped when container listener mode is ListenerMode.BATCH.
SqsContainerOptionsBuilder	messageAttributeNames(Collection<String> messageAttributeNames)	Set the messageAttributeNames that will be retrieved and added as headers in messages.
SqsContainerOptionsBuilder	messageSystemAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.MessageSystemAttributeName> messageSystemAttributeNames)	Set the MessageSystemAttributeNames that will be retrieved and added as headers in messages.
SqsContainerOptionsBuilder	messageVisibility(Duration messageVisibility)	Set the message visibility for messages retrieved by the container.
SqsContainerOptionsBuilder	queueAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.QueueAttributeName> queueAttributeNames)	Set the QueueAttributeNames that will be retrieved from the queue and added as headers to the messages.
SqsContainerOptionsBuilder	queueNotFoundStrategy(QueueNotFoundStrategy queueNotFoundStrategy)	Set the QueueNotFoundStrategy for the container.

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

acknowledgementInterval, acknowledgementMode, acknowledgementOrdering, acknowledgementResultTaskExecutor, acknowledgementShutdownTimeout, acknowledgementThreshold, autoStartup, backPressureMode, build, componentsTaskExecutor, createCopy, fromBuilder, listenerMode, listenerShutdownTimeout, maxConcurrentMessages, maxDelayBetweenPolls, maxMessagesPerPoll, messageConverter, pollBackOffPolicy, pollTimeout

Method Details

queueAttributeNames

SqsContainerOptionsBuilder queueAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.QueueAttributeName> queueAttributeNames)

Set the QueueAttributeNames that will be retrieved from the queue and added as headers to the messages. Default is none.

Parameters:

queueAttributeNames - the names.

Returns:

this instance.

messageAttributeNames

SqsContainerOptionsBuilder messageAttributeNames(Collection<String> messageAttributeNames)

Set the messageAttributeNames that will be retrieved and added as headers in messages. Default is ALL.

Parameters:

messageAttributeNames - the names.

Returns:

this instance.

messageSystemAttributeNames

SqsContainerOptionsBuilder messageSystemAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.MessageSystemAttributeName> messageSystemAttributeNames)

Set the MessageSystemAttributeNames that will be retrieved and added as headers in messages.

Parameters:

messageSystemAttributeNames - the names.

Returns:

this instance.

messageVisibility

SqsContainerOptionsBuilder messageVisibility(Duration messageVisibility)

Set the message visibility for messages retrieved by the container.

Parameters:

messageVisibility - the visibility timeout.

Returns:

this instance.

fifoBatchGroupingStrategy

SqsContainerOptionsBuilder fifoBatchGroupingStrategy(FifoBatchGroupingStrategy fifoBatchGroupingStrategy)

Set how the messages from FIFO queues should be grouped when container listener mode is ListenerMode.BATCH. By default, messages are grouped in batches by message group, which are processed in parallel, maintaining order within each message group.

Parameters:

fifoBatchGroupingStrategy - the strategy to batch FIFO messages.

Returns:

this instance.

queueNotFoundStrategy

SqsContainerOptionsBuilder queueNotFoundStrategy(QueueNotFoundStrategy queueNotFoundStrategy)

Set the QueueNotFoundStrategy for the container.

Parameters:

queueNotFoundStrategy - the strategy.

Returns:

this instance.