SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

SqsEndpointBuilderFactory.SqsEndpointBuilder

Enclosing interface:

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

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default SqsEndpointBuilderFactory.AdvancedSqsEndpointConsumerBuilder`	`advanced()`
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`amazonAWSHost(String amazonAWSHost)` The hostname of the Amazon AWS cloud.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`amazonSQSClient(Object amazonSQSClient)` To use the AmazonSQS as client.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`amazonSQSClient(String amazonSQSClient)` To use the AmazonSQS as client.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`attributeNames(String attributeNames)` A list of attribute names to receive when consuming.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`autoCreateQueue(boolean autoCreateQueue)` Setting the autocreation of the queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`autoCreateQueue(String autoCreateQueue)` Setting the autocreation of the queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`concurrentConsumers(int concurrentConsumers)` Allows you to use multiple threads to poll the sqs queue to increase throughput.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`concurrentConsumers(String concurrentConsumers)` Allows you to use multiple threads to poll the sqs queue to increase throughput.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`defaultVisibilityTimeout(Integer defaultVisibilityTimeout)` The default visibility timeout (in seconds).
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`defaultVisibilityTimeout(String defaultVisibilityTimeout)` The default visibility timeout (in seconds).
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`deleteAfterRead(boolean deleteAfterRead)` Delete message from SQS after it has been read.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`deleteAfterRead(String deleteAfterRead)` Delete message from SQS after it has been read.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`deleteIfFiltered(boolean deleteIfFiltered)` Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`deleteIfFiltered(String deleteIfFiltered)` Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`extendMessageVisibility(boolean extendMessageVisibility)` If enabled then a scheduled background task will keep extending the message visibility on SQS.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`extendMessageVisibility(String extendMessageVisibility)` If enabled then a scheduled background task will keep extending the message visibility on SQS.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`headerFilterStrategy(String headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`kmsMasterKeyId(String kmsMasterKeyId)` The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`maximumMessageSize(Integer maximumMessageSize)` The maximumMessageSize (in bytes) an SQS message can contain for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`maximumMessageSize(String maximumMessageSize)` The maximumMessageSize (in bytes) an SQS message can contain for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`maxMessagesPerPoll(int maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`maxMessagesPerPoll(String maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`messageAttributeNames(String messageAttributeNames)` A list of message attribute names to receive when consuming.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`messageRetentionPeriod(Integer messageRetentionPeriod)` The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`messageRetentionPeriod(String messageRetentionPeriod)` The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`policy(String policy)` The policy for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`protocol(String protocol)` The underlying protocol used to communicate with SQS.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`proxyPort(String proxyPort)` To define a proxy port when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`proxyProtocol(SqsEndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`queueOwnerAWSAccountId(String queueOwnerAWSAccountId)` Specify the queue owner aws account id when you need to connect the queue with different account owner.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`redrivePolicy(String redrivePolicy)` Specify the policy that send message to DeadLetter queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`region(String region)` Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)` Define if Server Side Encryption is enabled or not on the queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`serverSideEncryptionEnabled(String serverSideEncryptionEnabled)` Define if Server Side Encryption is enabled or not on the queue.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder`	`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 SqsEndpointBuilderFactory.AdvancedSqsEndpointConsumerBuilder advanced()
```
  - amazonAWSHost
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder amazonSQSClient(Object amazonSQSClient)
```
    To use the AmazonSQS as client. The option is a: com.amazonaws.services.sqs.AmazonSQS type. Group: common
  - amazonSQSClient
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder amazonSQSClient(String amazonSQSClient)
```
    To use the AmazonSQS as client. The option will be converted to a com.amazonaws.services.sqs.AmazonSQS type. Group: common
  - autoCreateQueue
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder autoCreateQueue(boolean autoCreateQueue)
```
    Setting the autocreation of the queue. The option is a: boolean type. Default: true Group: common
  - autoCreateQueue
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder autoCreateQueue(String autoCreateQueue)
```
    Setting the autocreation of the queue. The option will be converted to a boolean type. Default: true Group: common
  - autoDiscoverClient
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder proxyProtocol(SqsEndpointBuilderFactory.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the SQS client. The option is a: com.amazonaws.Protocol type. Default: HTTPS Group: common
  - proxyProtocol
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder proxyProtocol(String proxyProtocol)
```
    To define a proxy protocol when instantiating the SQS client. The option will be converted to a com.amazonaws.Protocol type. Default: HTTPS Group: common
  - queueOwnerAWSAccountId
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder region(String region)
```
    Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name(). The option is a: java.lang.String type. Group: common
  - attributeNames
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder defaultVisibilityTimeout(Integer defaultVisibilityTimeout)
```
    The default visibility timeout (in seconds). The option is a: java.lang.Integer type. Group: consumer
  - defaultVisibilityTimeout
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder defaultVisibilityTimeout(String defaultVisibilityTimeout)
```
    The default visibility timeout (in seconds). The option will be converted to a java.lang.Integer type. Group: consumer
  - deleteAfterRead
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder deleteAfterRead(boolean deleteAfterRead)
```
    Delete message from SQS after it has been read. The option is a: boolean type. Default: true Group: consumer
  - deleteAfterRead
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder policy(String policy)
```
    The policy for this queue. The option is a: java.lang.String type. Group: queue
  - receiveMessageWaitTimeSeconds
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder delay(long delay)
```
    Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
  - delay
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder delay(String delay)
```
    Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
  - greedy
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder initialDelay(long initialDelay)
```
    Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
  - initialDelay
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder initialDelay(String initialDelay)
```
    Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
  - repeatCount
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder startScheduler(boolean startScheduler)
```
    Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
  - startScheduler
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
  - secretKey
```
default SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

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

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

schedulerProperties

schedulerProperties