Class SqsEndpoint

java.lang.Object

io.awspring.cloud.sqs.config.AbstractEndpoint

io.awspring.cloud.sqs.config.SqsEndpoint

All Implemented Interfaces:

Endpoint, HandlerMethodEndpoint

public class SqsEndpoint
extends AbstractEndpoint

Endpoint implementation for SQS endpoints. Contains properties that should be mapped from @SqsListener annotations.

Since:

3.0

Author:

Tomaz Fernandes, Joao Calassio

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SqsEndpoint.SqsEndpointBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SqsEndpoint(SqsEndpoint.SqsEndpointBuilder builder)

Method Summary

Modifier and Type	Method	Description
static SqsEndpoint.SqsEndpointBuilder	builder()	Return a SqsEndpoint.SqsEndpointBuilder instance with the provided queue names.
@Nullable AcknowledgementMode	getAcknowledgementMode()	Returns the acknowledgement mode configured for this endpoint.
@Nullable Integer	getMaxConcurrentMessages()	Set the maximum concurrent messages that can be processed simultaneously for each queue.
@Nullable Integer	getMaxMessagesPerPoll()	Return the maximum amount of messages that should be returned in a poll.
@Nullable Duration	getMessageVisibility()	Return the message visibility for this endpoint.
@Nullable Duration	getPollTimeout()	The maximum duration to wait for messages in a given poll.

Methods inherited from class io.awspring.cloud.sqs.config.AbstractEndpoint

configureListenerMode, createAsyncMessageListenerInstance, createMessageListenerInstance, getBean, getId, getListenerContainerFactoryName, getLogicalNames, getMessageHandlerMethodFactory, setArgumentResolvers, setBean, setHandlerMethodFactory, setMethod, setMethodPayloadTypeInferrer, setupContainer

Methods inherited from class java.lang.Object

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

Constructor Details

SqsEndpoint

protected SqsEndpoint(SqsEndpoint.SqsEndpointBuilder builder)

Method Details

builder

public static SqsEndpoint.SqsEndpointBuilder builder()

Return a SqsEndpoint.SqsEndpointBuilder instance with the provided queue names.

Returns:

the builder instance.

getMaxConcurrentMessages

public @Nullable Integer getMaxConcurrentMessages()

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

Returns:

the maximum number of inflight messages.

getPollTimeout

public @Nullable Duration getPollTimeout()

The maximum duration to wait for messages in a given poll.

Returns:

the poll timeout.

getMaxMessagesPerPoll

public @Nullable Integer getMaxMessagesPerPoll()

Return the maximum amount of messages that should be returned in a poll.

Returns:

the maximum amount of messages.

getMessageVisibility

public @Nullable Duration getMessageVisibility()

Return the message visibility for this endpoint.

Returns:

the message visibility.

getAcknowledgementMode

public @Nullable AcknowledgementMode getAcknowledgementMode()

Returns the acknowledgement mode configured for this endpoint.

Returns:

the acknowledgement mode.