SqsEndpointBuilderFactory.SqsEndpointProducerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

SqsEndpointBuilderFactory.SqsEndpointBuilder

Enclosing interface:

SqsEndpointBuilderFactory
```
public static interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint producers for the AWS Simple Queue Service (SQS) component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default SqsEndpointBuilderFactory.AdvancedSqsEndpointProducerBuilder`	`advanced()`
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`amazonAWSHost(String amazonAWSHost)` The hostname of the Amazon AWS cloud.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`amazonSQSClient(Object amazonSQSClient)` To use the AmazonSQS as client.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`amazonSQSClient(String amazonSQSClient)` To use the AmazonSQS as client.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`autoCreateQueue(boolean autoCreateQueue)` Setting the autocreation of the queue.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`autoCreateQueue(String autoCreateQueue)` Setting the autocreation of the queue.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`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.SqsEndpointProducerBuilder`	`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.SqsEndpointProducerBuilder`	`delaySeconds(Integer delaySeconds)` Delay sending messages for a number of seconds.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`delaySeconds(String delaySeconds)` Delay sending messages for a number of seconds.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`headerFilterStrategy(String headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`maximumMessageSize(Integer maximumMessageSize)` The maximumMessageSize (in bytes) an SQS message can contain for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`maximumMessageSize(String maximumMessageSize)` The maximumMessageSize (in bytes) an SQS message can contain for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`messageDeduplicationIdStrategy(Object messageDeduplicationIdStrategy)` Only for FIFO queues.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`messageDeduplicationIdStrategy(String messageDeduplicationIdStrategy)` Only for FIFO queues.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`messageGroupIdStrategy(Object messageGroupIdStrategy)` Only for FIFO queues.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`messageGroupIdStrategy(String messageGroupIdStrategy)` Only for FIFO queues.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`messageRetentionPeriod(Integer messageRetentionPeriod)` The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`messageRetentionPeriod(String messageRetentionPeriod)` The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`operation(SqsEndpointBuilderFactory.SqsOperations operation)` The operation to do in case the user don't want to send only a message.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`operation(String operation)` The operation to do in case the user don't want to send only a message.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`policy(String policy)` The policy for this queue.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`protocol(String protocol)` The underlying protocol used to communicate with SQS.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`proxyPort(String proxyPort)` To define a proxy port when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`proxyProtocol(SqsEndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the SQS client.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`queueOwnerAWSAccountId(String queueOwnerAWSAccountId)` Specify the queue owner aws account id when you need to connect the queue with different account owner.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`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.SqsEndpointProducerBuilder`	`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.SqsEndpointProducerBuilder`	`redrivePolicy(String redrivePolicy)` Specify the policy that send message to DeadLetter queue.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`region(String region)` Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL.
`default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.

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

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

- Method Detail
  - advanced
```
default SqsEndpointBuilderFactory.AdvancedSqsEndpointProducerBuilder advanced()
```
  - amazonAWSHost
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder amazonSQSClient(Object amazonSQSClient)
```
    To use the AmazonSQS as client. The option is a: com.amazonaws.services.sqs.AmazonSQS type. Group: common
  - amazonSQSClient
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder autoCreateQueue(boolean autoCreateQueue)
```
    Setting the autocreation of the queue. The option is a: boolean type. Default: true Group: common
  - autoCreateQueue
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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
  - delaySeconds
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder delaySeconds(Integer delaySeconds)
```
    Delay sending messages for a number of seconds. The option is a: java.lang.Integer type. Group: producer
  - delaySeconds
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder delaySeconds(String delaySeconds)
```
    Delay sending messages for a number of seconds. The option will be converted to a java.lang.Integer type. Group: producer
  - lazyStartProducer
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
  - lazyStartProducer
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a boolean type. Default: false Group: producer
  - messageDeduplicationIdStrategy
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder messageDeduplicationIdStrategy(Object messageDeduplicationIdStrategy)
```
    Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. The option is a: org.apache.camel.component.aws.sqs.MessageDeduplicationIdStrategy type. Default: useExchangeId Group: producer
  - messageDeduplicationIdStrategy
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder messageDeduplicationIdStrategy(String messageDeduplicationIdStrategy)
```
    Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. The option will be converted to a org.apache.camel.component.aws.sqs.MessageDeduplicationIdStrategy type. Default: useExchangeId Group: producer
  - messageGroupIdStrategy
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder messageGroupIdStrategy(Object messageGroupIdStrategy)
```
    Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. The option is a: org.apache.camel.component.aws.sqs.MessageGroupIdStrategy type. Group: producer
  - messageGroupIdStrategy
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder messageGroupIdStrategy(String messageGroupIdStrategy)
```
    Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. The option will be converted to a org.apache.camel.component.aws.sqs.MessageGroupIdStrategy type. Group: producer
  - operation
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder operation(SqsEndpointBuilderFactory.SqsOperations operation)
```
    The operation to do in case the user don't want to send only a message. The option is a: org.apache.camel.component.aws.sqs.SqsOperations type. Group: producer
  - operation
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder operation(String operation)
```
    The operation to do in case the user don't want to send only a message. The option will be converted to a org.apache.camel.component.aws.sqs.SqsOperations type. Group: producer
  - proxyHost
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder policy(String policy)
```
    The policy for this queue. The option is a: java.lang.String type. Group: queue
  - receiveMessageWaitTimeSeconds
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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.SqsEndpointProducerBuilder 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
  - accessKey
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
  - secretKey
```
default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

amazonAWSHost

amazonSQSClient

amazonSQSClient

autoCreateQueue

autoCreateQueue

autoDiscoverClient

autoDiscoverClient

headerFilterStrategy

headerFilterStrategy

protocol

proxyProtocol

proxyProtocol

queueOwnerAWSAccountId

region

delaySeconds

delaySeconds

lazyStartProducer

lazyStartProducer

messageDeduplicationIdStrategy

messageDeduplicationIdStrategy

messageGroupIdStrategy

messageGroupIdStrategy

operation

operation

proxyHost

proxyPort

proxyPort

maximumMessageSize

maximumMessageSize

messageRetentionPeriod

messageRetentionPeriod

policy

receiveMessageWaitTimeSeconds

receiveMessageWaitTimeSeconds

redrivePolicy

accessKey

secretKey