Package io.awspring.cloud.sqs.listener

Class SqsContainerOptions.BuilderImpl

java.lang.Object

io.awspring.cloud.sqs.listener.AbstractContainerOptions.Builder<SqsContainerOptionsBuilder,SqsContainerOptions>

io.awspring.cloud.sqs.listener.SqsContainerOptions.BuilderImpl

All Implemented Interfaces:

ContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions>, SqsContainerOptionsBuilder

Enclosing class:

SqsContainerOptions

protected static class SqsContainerOptions.BuilderImpl
extends AbstractContainerOptions.Builder<SqsContainerOptionsBuilder,SqsContainerOptions>
implements SqsContainerOptionsBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderImpl()
protected	BuilderImpl(SqsContainerOptions options)

Method Summary

Modifier and Type	Method	Description
SqsContainerOptions	build()	Create the ContainerOptions instance.
SqsContainerOptionsBuilder	createCopy()	Create a copy of this builder.
SqsContainerOptionsBuilder	fifoBatchGroupingStrategy(FifoBatchGroupingStrategy fifoBatchGroupingStrategy)	Set how the messages from FIFO queues should be grouped when container listener mode is ListenerMode.BATCH.
void	fromBuilder(SqsContainerOptionsBuilder builder)	Copy the given builder settings to this builder.
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	observationConvention(SqsListenerObservation.Convention observationConvention)	Set a custom SqsListenerObservation.Convention to be used in this 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 class io.awspring.cloud.sqs.listener.AbstractContainerOptions.Builder

acknowledgementInterval, acknowledgementMode, acknowledgementOrdering, acknowledgementResultTaskExecutor, acknowledgementShutdownTimeout, acknowledgementThreshold, autoStartup, backPressureMode, componentsTaskExecutor, listenerMode, listenerShutdownTimeout, maxConcurrentMessages, maxDelayBetweenPolls, maxMessagesPerPoll, messageConverter, observationConvention, observationRegistry, pollBackOffPolicy, pollTimeout

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.ContainerOptionsBuilder

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

Constructor Details

BuilderImpl

protected BuilderImpl()

BuilderImpl

protected BuilderImpl(SqsContainerOptions options)

Method Details

queueAttributeNames

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

Description copied from interface: SqsContainerOptionsBuilder

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

Specified by:

queueAttributeNames in interface SqsContainerOptionsBuilder

Parameters:

queueAttributeNames - the names.

Returns:

this instance.

messageAttributeNames

public SqsContainerOptionsBuilder messageAttributeNames(Collection<String> messageAttributeNames)

Description copied from interface: SqsContainerOptionsBuilder

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

Specified by:

messageAttributeNames in interface SqsContainerOptionsBuilder

Parameters:

messageAttributeNames - the names.

Returns:

this instance.

messageSystemAttributeNames

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

Description copied from interface: SqsContainerOptionsBuilder

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

Specified by:

messageSystemAttributeNames in interface SqsContainerOptionsBuilder

Parameters:

messageSystemAttributeNames - the names.

Returns:

this instance.

messageVisibility

public SqsContainerOptionsBuilder messageVisibility(Duration messageVisibility)

Description copied from interface: SqsContainerOptionsBuilder

Set the message visibility for messages retrieved by the container.

Specified by:

messageVisibility in interface SqsContainerOptionsBuilder

Parameters:

messageVisibility - the visibility timeout.

Returns:

this instance.

fifoBatchGroupingStrategy

public SqsContainerOptionsBuilder fifoBatchGroupingStrategy(FifoBatchGroupingStrategy fifoBatchGroupingStrategy)

Description copied from interface: SqsContainerOptionsBuilder

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.

Specified by:

fifoBatchGroupingStrategy in interface SqsContainerOptionsBuilder

Parameters:

fifoBatchGroupingStrategy - the strategy to batch FIFO messages.

Returns:

this instance.

queueNotFoundStrategy

public SqsContainerOptionsBuilder queueNotFoundStrategy(QueueNotFoundStrategy queueNotFoundStrategy)

Description copied from interface: SqsContainerOptionsBuilder

Set the QueueNotFoundStrategy for the container.

Specified by:

queueNotFoundStrategy in interface SqsContainerOptionsBuilder

Parameters:

queueNotFoundStrategy - the strategy.

Returns:

this instance.

observationConvention

public SqsContainerOptionsBuilder observationConvention(SqsListenerObservation.Convention observationConvention)

Description copied from interface: SqsContainerOptionsBuilder

Set a custom SqsListenerObservation.Convention to be used in this container.

Specified by:

observationConvention in interface SqsContainerOptionsBuilder

Parameters:

observationConvention - the custom observation convention.

Returns:

this instance.

build

public SqsContainerOptions build()

Description copied from interface: ContainerOptionsBuilder

Create the ContainerOptions instance.

Specified by:

build in interface ContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions>

Returns:

the new instance.

createCopy

public SqsContainerOptionsBuilder createCopy()

Description copied from interface: ContainerOptionsBuilder

Create a copy of this builder.

Specified by:

createCopy in interface ContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions>

Returns:

the copy.

fromBuilder

public void fromBuilder(SqsContainerOptionsBuilder builder)

Description copied from interface: ContainerOptionsBuilder

Copy the given builder settings to this builder.

Specified by:

fromBuilder in interface ContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions>

Parameters:

builder - the builder from which to copy settings from.