Package io.awspring.cloud.sqs.listener

Class AbstractContainerOptions.Builder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

java.lang.Object

io.awspring.cloud.sqs.listener.AbstractContainerOptions.Builder<B,O>

All Implemented Interfaces:

ContainerOptionsBuilder<B,O>

Enclosing class:

AbstractContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

protected abstract static class AbstractContainerOptions.Builder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>
extends Object
implements ContainerOptionsBuilder<B,O>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(AbstractContainerOptions<?,?> options)

Method Summary

Modifier and Type	Method	Description
B	acknowledgementInterval(Duration acknowledgementInterval)	Set the maximum interval between acknowledgements for batch acknowledgements.
B	acknowledgementMode(AcknowledgementMode acknowledgementMode)	Set the AcknowledgementMode for this container.
B	acknowledgementOrdering(AcknowledgementOrdering acknowledgementOrdering)	Set the AcknowledgementOrdering for this container.
B	acknowledgementResultTaskExecutor(TaskExecutor taskExecutor)	Set the TaskExecutor to be used by blocking AcknowledgementResultCallback implementations for this container.
B	acknowledgementShutdownTimeout(Duration acknowledgementShutdownTimeout)	Set the maximum amount of time that the container should wait for batched acknowledgements to finish before shutting down.
B	acknowledgementThreshold(int acknowledgementThreshold)	Set the threshold for triggering a batch acknowledgement.
B	autoStartup(boolean autoStartup)	Set whether the container should be started automatically or manually.
B	backPressureMode(BackPressureMode backPressureMode)	Set the BackPressureMode for this container.
B	componentsTaskExecutor(TaskExecutor taskExecutor)	Set the TaskExecutor to be used by this container's components.
B	listenerMode(ListenerMode listenerMode)	Set the ListenerMode mode for this container.
B	listenerShutdownTimeout(Duration listenerShutdownTimeout)	Set the maximum amount of time that the container should wait for tasks to finish before shutting down.
B	maxConcurrentMessages(int maxConcurrentMessages)	Set the maximum concurrent messages that can be processed simultaneously for each queue.
B	maxDelayBetweenPolls(Duration maxDelayBetweenPolls)	Set the maximum time the polling thread should wait for a full batch of permits to be available before trying to acquire a partial batch if so configured.
B	maxMessagesPerPoll(int maxMessagesPerPoll)	Set the number of messages that should be returned per poll.
B	messageConverter(MessagingMessageConverter<?> messageConverter)	Set the MessagingMessageConverter for this container.
B	pollBackOffPolicy(org.springframework.retry.backoff.BackOffPolicy pollBackOffPolicy)	Set the BackOffPolicy to use when polling throws an exception.
B	pollTimeout(Duration pollTimeout)	Set the timeout for polling messages for this endpoint.

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

build, createCopy, fromBuilder

Constructor Details

Builder

protected Builder()

Builder

protected Builder(AbstractContainerOptions<?,?> options)

Method Details

maxConcurrentMessages

public B maxConcurrentMessages(int maxConcurrentMessages)

Description copied from interface: ContainerOptionsBuilder

Set the maximum concurrent messages that can be processed simultaneously for each queue. Default is 10. Note that if acknowledgement batching is being used, the actual maximum number of inflight messages might be higher.

Specified by:

maxConcurrentMessages in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Returns:

this instance.

maxMessagesPerPoll

public B maxMessagesPerPoll(int maxMessagesPerPoll)

Description copied from interface: ContainerOptionsBuilder

Set the number of messages that should be returned per poll. If a value greater than 10 is provided, the result of multiple polls will be combined, which can be useful for ListenerMode.BATCH Default is 10.

Specified by:

maxMessagesPerPoll in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

maxMessagesPerPoll - the number of messages.

Returns:

this instance.

autoStartup

public B autoStartup(boolean autoStartup)

Description copied from interface: ContainerOptionsBuilder

Set whether the container should be started automatically or manually. By default, the container is set to start automatically.

Specified by:

autoStartup in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

autoStartup - true if the container is set to start automatically, false if it should be started manually

Returns:

this instance.

pollTimeout

public B pollTimeout(Duration pollTimeout)

Description copied from interface: ContainerOptionsBuilder

Set the timeout for polling messages for this endpoint. Default is 10 seconds.

Specified by:

pollTimeout in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

pollTimeout - the poll timeout.

Returns:

this instance.

pollBackOffPolicy

public B pollBackOffPolicy(org.springframework.retry.backoff.BackOffPolicy pollBackOffPolicy)

Description copied from interface: ContainerOptionsBuilder

Set the BackOffPolicy to use when polling throws an exception.

Specified by:

pollBackOffPolicy in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

pollBackOffPolicy - the back off policy.

Returns:

this instance.

maxDelayBetweenPolls

public B maxDelayBetweenPolls(Duration maxDelayBetweenPolls)

Description copied from interface: ContainerOptionsBuilder

Set the maximum time the polling thread should wait for a full batch of permits to be available before trying to acquire a partial batch if so configured. A poll is only actually executed if at least one permit is available. Default is 10 seconds.

Specified by:

maxDelayBetweenPolls in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

maxDelayBetweenPolls - the maximum delay.

Returns:

this instance.

See Also:

• BackPressureMode

listenerMode

public B listenerMode(ListenerMode listenerMode)

Description copied from interface: ContainerOptionsBuilder

Set the ListenerMode mode for this container. Default is ListenerMode.SINGLE_MESSAGE

Specified by:

listenerMode in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

listenerMode - the listener mode.

Returns:

this instance.

componentsTaskExecutor

public B componentsTaskExecutor(TaskExecutor taskExecutor)

Description copied from interface: ContainerOptionsBuilder

Set the TaskExecutor to be used by this container's components. It's shared by the MessageSink and any blocking components the container might have. Due to performance concerns, the provided executor MUST have a MessageExecutionThreadFactory. The container should have enough Threads to support the full load, including if it's shared between containers.

Specified by:

componentsTaskExecutor in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

taskExecutor - the task executor.

Returns:

this instance.

See Also:

• ContainerOptions.getComponentsTaskExecutor()

acknowledgementResultTaskExecutor

public B acknowledgementResultTaskExecutor(TaskExecutor taskExecutor)

Description copied from interface: ContainerOptionsBuilder

Set the TaskExecutor to be used by blocking AcknowledgementResultCallback implementations for this container. Due to performance concerns, the provided executor MUST have a MessageExecutionThreadFactory. The container should have enough Threads to support the full load, including if it's shared between containers.

Specified by:

acknowledgementResultTaskExecutor in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

taskExecutor - the task executor.

Returns:

this instance.

listenerShutdownTimeout

public B listenerShutdownTimeout(Duration listenerShutdownTimeout)

Description copied from interface: ContainerOptionsBuilder

Set the maximum amount of time that the container should wait for tasks to finish before shutting down. Default is 20 seconds.

Specified by:

listenerShutdownTimeout in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

listenerShutdownTimeout - the timeout.

Returns:

this instance.

acknowledgementShutdownTimeout

public B acknowledgementShutdownTimeout(Duration acknowledgementShutdownTimeout)

Description copied from interface: ContainerOptionsBuilder

Set the maximum amount of time that the container should wait for batched acknowledgements to finish before shutting down. Note that this timeout starts counting after listener processing is done or timed out. Default is 20 seconds.

Specified by:

acknowledgementShutdownTimeout in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

acknowledgementShutdownTimeout - the timeout.

Returns:

this instance.

backPressureMode

public B backPressureMode(BackPressureMode backPressureMode)

Description copied from interface: ContainerOptionsBuilder

Set the BackPressureMode for this container. Default is BackPressureMode.AUTO

Specified by:

backPressureMode in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

backPressureMode - the backpressure mode.

Returns:

this instance.

acknowledgementInterval

public B acknowledgementInterval(Duration acknowledgementInterval)

Description copied from interface: ContainerOptionsBuilder

Set the maximum interval between acknowledgements for batch acknowledgements. The default depends on the specific ContainerComponentFactory implementation.

Specified by:

acknowledgementInterval in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

acknowledgementInterval - the interval.

Returns:

this instance.

acknowledgementThreshold

public B acknowledgementThreshold(int acknowledgementThreshold)

Description copied from interface: ContainerOptionsBuilder

Set the threshold for triggering a batch acknowledgement. The default depends on the specific ContainerComponentFactory implementation.

Specified by:

acknowledgementThreshold in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

acknowledgementThreshold - the threshold.

Returns:

this instance.

acknowledgementMode

public B acknowledgementMode(AcknowledgementMode acknowledgementMode)

Description copied from interface: ContainerOptionsBuilder

Set the AcknowledgementMode for this container. Default is AcknowledgementMode.ON_SUCCESS.

Specified by:

acknowledgementMode in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

acknowledgementMode - the acknowledgement mode.

Returns:

this instance.

acknowledgementOrdering

public B acknowledgementOrdering(AcknowledgementOrdering acknowledgementOrdering)

Description copied from interface: ContainerOptionsBuilder

Set the AcknowledgementOrdering for this container. Default is AcknowledgementOrdering.PARALLEL.

Specified by:

acknowledgementOrdering in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

acknowledgementOrdering - the acknowledgement ordering.

Returns:

this instance

messageConverter

public B messageConverter(MessagingMessageConverter<?> messageConverter)

Description copied from interface: ContainerOptionsBuilder

Set the MessagingMessageConverter for this container.

Specified by:

messageConverter in interface ContainerOptionsBuilder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Parameters:

messageConverter - the message converter.

Returns:

this instance.