Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder

Enclosing interface:

Sqs2EndpointBuilderFactory
```
public static interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the AWS 2 Simple Queue Service (SQS) component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder`	`advanced()`
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`amazonAWSHost(String amazonAWSHost)` The hostname of the Amazon AWS cloud.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`amazonSQSClient(Object amazonSQSClient)` To use the AmazonSQS as client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`amazonSQSClient(String amazonSQSClient)` To use the AmazonSQS as client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`attributeNames(String attributeNames)` A list of attribute names to receive when consuming.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`autoCreateQueue(boolean autoCreateQueue)` Setting the autocreation of the queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`autoCreateQueue(String autoCreateQueue)` Setting the autocreation of the queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`autoDiscoverClient(boolean autoDiscoverClient)` Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`autoDiscoverClient(String autoDiscoverClient)` Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`bridgeErrorHandler(String bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`concurrentConsumers(int concurrentConsumers)` Allows you to use multiple threads to poll the sqs queue to increase throughput.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`concurrentConsumers(String concurrentConsumers)` Allows you to use multiple threads to poll the sqs queue to increase throughput.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`defaultVisibilityTimeout(Integer defaultVisibilityTimeout)` The default visibility timeout (in seconds).
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`defaultVisibilityTimeout(String defaultVisibilityTimeout)` The default visibility timeout (in seconds).
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`deleteAfterRead(boolean deleteAfterRead)` Delete message from SQS after it has been read.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`deleteAfterRead(String deleteAfterRead)` Delete message from SQS after it has been read.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`deleteIfFiltered(boolean deleteIfFiltered)` Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`deleteIfFiltered(String deleteIfFiltered)` Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`extendMessageVisibility(boolean extendMessageVisibility)` If enabled then a scheduled background task will keep extending the message visibility on SQS.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`extendMessageVisibility(String extendMessageVisibility)` If enabled then a scheduled background task will keep extending the message visibility on SQS.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`headerFilterStrategy(String headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`kmsDataKeyReusePeriodSeconds(Integer kmsDataKeyReusePeriodSeconds)` The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`kmsDataKeyReusePeriodSeconds(String kmsDataKeyReusePeriodSeconds)` The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`kmsMasterKeyId(String kmsMasterKeyId)` The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`maximumMessageSize(Integer maximumMessageSize)` The maximumMessageSize (in bytes) an SQS message can contain for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`maximumMessageSize(String maximumMessageSize)` The maximumMessageSize (in bytes) an SQS message can contain for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`maxMessagesPerPoll(int maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`maxMessagesPerPoll(String maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`messageAttributeNames(String messageAttributeNames)` A list of message attribute names to receive when consuming.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`messageRetentionPeriod(Integer messageRetentionPeriod)` The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`messageRetentionPeriod(String messageRetentionPeriod)` The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`policy(String policy)` The policy for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`protocol(String protocol)` The underlying protocol used to communicate with SQS.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`proxyPort(String proxyPort)` To define a proxy port when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`proxyProtocol(Sqs2EndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`queueOwnerAWSAccountId(String queueOwnerAWSAccountId)` Specify the queue owner aws account id when you need to connect the queue with different account owner.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`receiveMessageWaitTimeSeconds(Integer receiveMessageWaitTimeSeconds)` If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`receiveMessageWaitTimeSeconds(String receiveMessageWaitTimeSeconds)` If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`redrivePolicy(String redrivePolicy)` Specify the policy that send message to DeadLetter queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`region(String region)` The region in which SQS client needs to work.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)` If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)` If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)` Define if Server Side Encryption is enabled or not on the queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`serverSideEncryptionEnabled(String serverSideEncryptionEnabled)` Define if Server Side Encryption is enabled or not on the queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`trustAllCertificates(boolean trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`trustAllCertificates(String trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`visibilityTimeout(Integer visibilityTimeout)` The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`visibilityTimeout(String visibilityTimeout)` The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`waitTimeSeconds(Integer waitTimeSeconds)` Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder`	`waitTimeSeconds(String waitTimeSeconds)` Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder advanced()
```
  - amazonAWSHost
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder amazonAWSHost(String amazonAWSHost)
```
    The hostname of the Amazon AWS cloud. The option is a: java.lang.String type. Default: amazonaws.com Group: common
  - amazonSQSClient
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder amazonSQSClient(Object amazonSQSClient)
```
    To use the AmazonSQS as client. The option is a: software.amazon.awssdk.services.sqs.SqsClient type. Group: common
  - amazonSQSClient
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder amazonSQSClient(String amazonSQSClient)
```
    To use the AmazonSQS as client. The option will be converted to a software.amazon.awssdk.services.sqs.SqsClient type. Group: common
  - autoCreateQueue
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder autoCreateQueue(boolean autoCreateQueue)
```
    Setting the autocreation of the queue. The option is a: boolean type. Default: true Group: common
  - autoCreateQueue
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder autoCreateQueue(String autoCreateQueue)
```
    Setting the autocreation of the queue. The option will be converted to a boolean type. Default: true Group: common
  - autoDiscoverClient
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder autoDiscoverClient(boolean autoDiscoverClient)
```
    Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a: boolean type. Default: true Group: common
  - autoDiscoverClient
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder autoDiscoverClient(String autoDiscoverClient)
```
    Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option will be converted to a boolean type. Default: true Group: common
  - headerFilterStrategy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
```
    To use a custom HeaderFilterStrategy to map headers to/from Camel. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: common
  - headerFilterStrategy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)
```
    To use a custom HeaderFilterStrategy to map headers to/from Camel. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: common
  - protocol
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder protocol(String protocol)
```
    The underlying protocol used to communicate with SQS. The option is a: java.lang.String type. Default: https Group: common
  - proxyProtocol
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder proxyProtocol(Sqs2EndpointBuilderFactory.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the SQS client. The option is a: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: common
  - proxyProtocol
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder proxyProtocol(String proxyProtocol)
```
    To define a proxy protocol when instantiating the SQS client. The option will be converted to a software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: common
  - queueOwnerAWSAccountId
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder queueOwnerAWSAccountId(String queueOwnerAWSAccountId)
```
    Specify the queue owner aws account id when you need to connect the queue with different account owner. The option is a: java.lang.String type. Group: common
  - region
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder region(String region)
```
    The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: java.lang.String type. Group: common
  - trustAllCertificates
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder trustAllCertificates(boolean trustAllCertificates)
```
    If we want to trust all certificates in case of overriding the endpoint. The option is a: boolean type. Default: false Group: common
  - trustAllCertificates
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder trustAllCertificates(String trustAllCertificates)
```
    If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a boolean type. Default: false Group: common
  - attributeNames
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder attributeNames(String attributeNames)
```
    A list of attribute names to receive when consuming. Multiple names can be separated by comma. The option is a: java.lang.String type. Group: consumer
  - bridgeErrorHandler
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer
  - bridgeErrorHandler
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a boolean type. Default: false Group: consumer
  - concurrentConsumers
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder concurrentConsumers(int concurrentConsumers)
```
    Allows you to use multiple threads to poll the sqs queue to increase throughput. The option is a: int type. Default: 1 Group: consumer
  - concurrentConsumers
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder concurrentConsumers(String concurrentConsumers)
```
    Allows you to use multiple threads to poll the sqs queue to increase throughput. The option will be converted to a int type. Default: 1 Group: consumer
  - defaultVisibilityTimeout
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder defaultVisibilityTimeout(Integer defaultVisibilityTimeout)
```
    The default visibility timeout (in seconds). The option is a: java.lang.Integer type. Group: consumer
  - defaultVisibilityTimeout
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder defaultVisibilityTimeout(String defaultVisibilityTimeout)
```
    The default visibility timeout (in seconds). The option will be converted to a java.lang.Integer type. Group: consumer
  - deleteAfterRead
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteAfterRead(boolean deleteAfterRead)
```
    Delete message from SQS after it has been read. The option is a: boolean type. Default: true Group: consumer
  - deleteAfterRead
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteAfterRead(String deleteAfterRead)
```
    Delete message from SQS after it has been read. The option will be converted to a boolean type. Default: true Group: consumer
  - deleteIfFiltered
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteIfFiltered(boolean deleteIfFiltered)
```
    Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage. The option is a: boolean type. Default: true Group: consumer
  - deleteIfFiltered
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteIfFiltered(String deleteIfFiltered)
```
    Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage. The option will be converted to a boolean type. Default: true Group: consumer
  - extendMessageVisibility
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder extendMessageVisibility(boolean extendMessageVisibility)
```
    If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. The option is a: boolean type. Default: false Group: consumer
  - extendMessageVisibility
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder extendMessageVisibility(String extendMessageVisibility)
```
    If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. The option will be converted to a boolean type. Default: false Group: consumer
  - kmsDataKeyReusePeriodSeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder kmsDataKeyReusePeriodSeconds(Integer kmsDataKeyReusePeriodSeconds)
```
    The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). The option is a: java.lang.Integer type. Group: consumer
  - kmsDataKeyReusePeriodSeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder kmsDataKeyReusePeriodSeconds(String kmsDataKeyReusePeriodSeconds)
```
    The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). The option will be converted to a java.lang.Integer type. Group: consumer
  - kmsMasterKeyId
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder kmsMasterKeyId(String kmsMasterKeyId)
```
    The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. The option is a: java.lang.String type. Group: consumer
  - maxMessagesPerPoll
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
```
    Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. The option is a: int type. Group: consumer
  - maxMessagesPerPoll
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)
```
    Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. The option will be converted to a int type. Group: consumer
  - messageAttributeNames
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder messageAttributeNames(String messageAttributeNames)
```
    A list of message attribute names to receive when consuming. Multiple names can be separated by comma. The option is a: java.lang.String type. Group: consumer
  - sendEmptyMessageWhenIdle
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
```
    If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: boolean type. Default: false Group: consumer
  - sendEmptyMessageWhenIdle
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
```
    If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a boolean type. Default: false Group: consumer
  - serverSideEncryptionEnabled
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
```
    Define if Server Side Encryption is enabled or not on the queue. The option is a: boolean type. Default: false Group: consumer
  - serverSideEncryptionEnabled
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder serverSideEncryptionEnabled(String serverSideEncryptionEnabled)
```
    Define if Server Side Encryption is enabled or not on the queue. The option will be converted to a boolean type. Default: false Group: consumer
  - visibilityTimeout
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder visibilityTimeout(Integer visibilityTimeout)
```
    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. The option is a: java.lang.Integer type. Group: consumer
  - visibilityTimeout
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder visibilityTimeout(String visibilityTimeout)
```
    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. The option will be converted to a java.lang.Integer type. Group: consumer
  - waitTimeSeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder waitTimeSeconds(Integer waitTimeSeconds)
```
    Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. The option is a: java.lang.Integer type. Group: consumer
  - waitTimeSeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder waitTimeSeconds(String waitTimeSeconds)
```
    Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. The option will be converted to a java.lang.Integer type. Group: consumer
  - proxyHost
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder proxyHost(String proxyHost)
```
    To define a proxy host when instantiating the SQS client. The option is a: java.lang.String type. Group: proxy
  - proxyPort
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder proxyPort(Integer proxyPort)
```
    To define a proxy port when instantiating the SQS client. The option is a: java.lang.Integer type. Group: proxy
  - proxyPort
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder proxyPort(String proxyPort)
```
    To define a proxy port when instantiating the SQS client. The option will be converted to a java.lang.Integer type. Group: proxy
  - maximumMessageSize
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder maximumMessageSize(Integer maximumMessageSize)
```
    The maximumMessageSize (in bytes) an SQS message can contain for this queue. The option is a: java.lang.Integer type. Group: queue
  - maximumMessageSize
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder maximumMessageSize(String maximumMessageSize)
```
    The maximumMessageSize (in bytes) an SQS message can contain for this queue. The option will be converted to a java.lang.Integer type. Group: queue
  - messageRetentionPeriod
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder messageRetentionPeriod(Integer messageRetentionPeriod)
```
    The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. The option is a: java.lang.Integer type. Group: queue
  - messageRetentionPeriod
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder messageRetentionPeriod(String messageRetentionPeriod)
```
    The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. The option will be converted to a java.lang.Integer type. Group: queue
  - policy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder policy(String policy)
```
    The policy for this queue. The option is a: java.lang.String type. Group: queue
  - receiveMessageWaitTimeSeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder receiveMessageWaitTimeSeconds(Integer receiveMessageWaitTimeSeconds)
```
    If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. The option is a: java.lang.Integer type. Group: queue
  - receiveMessageWaitTimeSeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder receiveMessageWaitTimeSeconds(String receiveMessageWaitTimeSeconds)
```
    If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. The option will be converted to a java.lang.Integer type. Group: queue
  - redrivePolicy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder redrivePolicy(String redrivePolicy)
```
    Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. The option is a: java.lang.String type. Group: queue
  - backoffErrorThreshold
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
```
    The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
  - backoffErrorThreshold
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
```
    The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
  - backoffIdleThreshold
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
  - backoffIdleThreshold
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
  - backoffMultiplier
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
```
    To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: int type. Group: scheduler
  - backoffMultiplier
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
```
    To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a int type. Group: scheduler
  - delay
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder delay(long delay)
```
    Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
  - delay
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder delay(String delay)
```
    Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
  - greedy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder greedy(boolean greedy)
```
    If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: boolean type. Default: false Group: scheduler
  - greedy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder greedy(String greedy)
```
    If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a boolean type. Default: false Group: scheduler
  - initialDelay
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder initialDelay(long initialDelay)
```
    Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
  - initialDelay
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder initialDelay(String initialDelay)
```
    Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
  - repeatCount
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder repeatCount(long repeatCount)
```
    Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: long type. Default: 0 Group: scheduler
  - repeatCount
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder repeatCount(String repeatCount)
```
    Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a long type. Default: 0 Group: scheduler
  - runLoggingLevel
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
```
    The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
  - runLoggingLevel
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
```
    The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
  - scheduledExecutorService
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
```
    Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
  - scheduledExecutorService
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
```
    Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a java.util.concurrent.ScheduledExecutorService type. Group: scheduler
  - scheduler
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder scheduler(Object scheduler)
```
    To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: java.lang.Object type. Default: none Group: scheduler
  - scheduler
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder scheduler(String scheduler)
```
    To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a java.lang.Object type. Default: none Group: scheduler
  - schedulerProperties
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder schedulerProperties(String key,
                                                                                   Object value)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
  - schedulerProperties
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder schedulerProperties(Map values)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
  - startScheduler
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder startScheduler(boolean startScheduler)
```
    Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
  - startScheduler
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder startScheduler(String startScheduler)
```
    Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
  - timeUnit
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
```
    Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
  - timeUnit
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder timeUnit(String timeUnit)
```
    Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
  - useFixedDelay
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
  - useFixedDelay
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder useFixedDelay(String useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a boolean type. Default: true Group: scheduler
  - accessKey
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
  - secretKey
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

amazonAWSHost

amazonSQSClient

amazonSQSClient

autoCreateQueue

autoCreateQueue

autoDiscoverClient

autoDiscoverClient

headerFilterStrategy

headerFilterStrategy

protocol

proxyProtocol

proxyProtocol

queueOwnerAWSAccountId

region

trustAllCertificates

trustAllCertificates

attributeNames

bridgeErrorHandler

bridgeErrorHandler

concurrentConsumers

concurrentConsumers

defaultVisibilityTimeout

defaultVisibilityTimeout

deleteAfterRead

deleteAfterRead

deleteIfFiltered

deleteIfFiltered

extendMessageVisibility

extendMessageVisibility

kmsDataKeyReusePeriodSeconds

kmsDataKeyReusePeriodSeconds

kmsMasterKeyId

maxMessagesPerPoll

maxMessagesPerPoll

messageAttributeNames

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

serverSideEncryptionEnabled

serverSideEncryptionEnabled

visibilityTimeout

visibilityTimeout

waitTimeSeconds

waitTimeSeconds

proxyHost

proxyPort

proxyPort

maximumMessageSize

maximumMessageSize

messageRetentionPeriod

messageRetentionPeriod

policy

receiveMessageWaitTimeSeconds

receiveMessageWaitTimeSeconds

redrivePolicy

backoffErrorThreshold

backoffErrorThreshold

backoffIdleThreshold

backoffIdleThreshold

backoffMultiplier

backoffMultiplier

delay

delay

greedy

greedy

initialDelay

initialDelay

repeatCount

repeatCount

runLoggingLevel

runLoggingLevel

scheduledExecutorService

scheduledExecutorService

scheduler

scheduler