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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Create theContainerOptionsinstance.Create a copy of this builder.fifoBatchGroupingStrategy(FifoBatchGroupingStrategy fifoBatchGroupingStrategy) Set how the messages from FIFO queues should be grouped when container listener mode isListenerMode.BATCH.voidfromBuilder(SqsContainerOptionsBuilder builder) Copy the given builder settings to this builder.messageAttributeNames(Collection<String> messageAttributeNames) Set the messageAttributeNames that will be retrieved and added as headers in messages.messageSystemAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.MessageSystemAttributeName> messageSystemAttributeNames) Set theMessageSystemAttributeNames that will be retrieved and added as headers in messages.messageVisibility(Duration messageVisibility) Set the message visibility for messages retrieved by the container.observationConvention(SqsListenerObservation.Convention observationConvention) Set a custom SqsListenerObservation.Convention to be used in this container.queueAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.QueueAttributeName> queueAttributeNames) Set theQueueAttributeNames that will be retrieved from the queue and added as headers to the messages.queueNotFoundStrategy(QueueNotFoundStrategy queueNotFoundStrategy) Set theQueueNotFoundStrategyfor 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, pollTimeoutMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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
-
-
Method Details
-
queueAttributeNames
public SqsContainerOptionsBuilder queueAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.QueueAttributeName> queueAttributeNames) Description copied from interface:SqsContainerOptionsBuilderSet theQueueAttributeNames that will be retrieved from the queue and added as headers to the messages. Default is none.- Specified by:
queueAttributeNamesin interfaceSqsContainerOptionsBuilder- Parameters:
queueAttributeNames- the names.- Returns:
- this instance.
-
messageAttributeNames
Description copied from interface:SqsContainerOptionsBuilderSet the messageAttributeNames that will be retrieved and added as headers in messages. Default is ALL.- Specified by:
messageAttributeNamesin interfaceSqsContainerOptionsBuilder- Parameters:
messageAttributeNames- the names.- Returns:
- this instance.
-
messageSystemAttributeNames
public SqsContainerOptionsBuilder messageSystemAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.MessageSystemAttributeName> messageSystemAttributeNames) Description copied from interface:SqsContainerOptionsBuilderSet theMessageSystemAttributeNames that will be retrieved and added as headers in messages.- Specified by:
messageSystemAttributeNamesin interfaceSqsContainerOptionsBuilder- Parameters:
messageSystemAttributeNames- the names.- Returns:
- this instance.
-
messageVisibility
Description copied from interface:SqsContainerOptionsBuilderSet the message visibility for messages retrieved by the container.- Specified by:
messageVisibilityin interfaceSqsContainerOptionsBuilder- Parameters:
messageVisibility- the visibility timeout.- Returns:
- this instance.
-
fifoBatchGroupingStrategy
public SqsContainerOptionsBuilder fifoBatchGroupingStrategy(FifoBatchGroupingStrategy fifoBatchGroupingStrategy) Description copied from interface:SqsContainerOptionsBuilderSet how the messages from FIFO queues should be grouped when container listener mode isListenerMode.BATCH. By default, messages are grouped in batches by message group, which are processed in parallel, maintaining order within each message group.- Specified by:
fifoBatchGroupingStrategyin interfaceSqsContainerOptionsBuilder- Parameters:
fifoBatchGroupingStrategy- the strategy to batch FIFO messages.- Returns:
- this instance.
-
queueNotFoundStrategy
public SqsContainerOptionsBuilder queueNotFoundStrategy(QueueNotFoundStrategy queueNotFoundStrategy) Description copied from interface:SqsContainerOptionsBuilderSet theQueueNotFoundStrategyfor the container.- Specified by:
queueNotFoundStrategyin interfaceSqsContainerOptionsBuilder- Parameters:
queueNotFoundStrategy- the strategy.- Returns:
- this instance.
-
observationConvention
public SqsContainerOptionsBuilder observationConvention(SqsListenerObservation.Convention observationConvention) Description copied from interface:SqsContainerOptionsBuilderSet a custom SqsListenerObservation.Convention to be used in this container.- Specified by:
observationConventionin interfaceSqsContainerOptionsBuilder- Parameters:
observationConvention- the custom observation convention.- Returns:
- this instance.
-
build
Description copied from interface:ContainerOptionsBuilderCreate theContainerOptionsinstance.- Specified by:
buildin interfaceContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions> - Returns:
- the new instance.
-
createCopy
Description copied from interface:ContainerOptionsBuilderCreate a copy of this builder.- Specified by:
createCopyin interfaceContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions> - Returns:
- the copy.
-
fromBuilder
Description copied from interface:ContainerOptionsBuilderCopy the given builder settings to this builder.- Specified by:
fromBuilderin interfaceContainerOptionsBuilder<SqsContainerOptionsBuilder,SqsContainerOptions> - Parameters:
builder- the builder from which to copy settings from.
-