Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder

Enclosing interface:

Sqs2EndpointBuilderFactory
```
public static interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint producers 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.Sqs2EndpointProducerBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointProducerBuilder`	`advanced()`
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`amazonAWSHost(String amazonAWSHost)` The hostname of the Amazon AWS cloud.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`amazonSQSClient(Object amazonSQSClient)` To use the AmazonSQS as client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`amazonSQSClient(String amazonSQSClient)` To use the AmazonSQS as client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`autoCreateQueue(boolean autoCreateQueue)` Setting the autocreation of the queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`autoCreateQueue(String autoCreateQueue)` Setting the autocreation of the queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`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.Sqs2EndpointProducerBuilder`	`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.Sqs2EndpointProducerBuilder`	`delaySeconds(Integer delaySeconds)` Delay sending messages for a number of seconds.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`delaySeconds(String delaySeconds)` Delay sending messages for a number of seconds.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`headerFilterStrategy(String headerFilterStrategy)` To use a custom HeaderFilterStrategy to map headers to/from Camel.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`maximumMessageSize(Integer maximumMessageSize)` The maximumMessageSize (in bytes) an SQS message can contain for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`maximumMessageSize(String maximumMessageSize)` The maximumMessageSize (in bytes) an SQS message can contain for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`messageDeduplicationIdStrategy(Object messageDeduplicationIdStrategy)` Only for FIFO queues.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`messageDeduplicationIdStrategy(String messageDeduplicationIdStrategy)` Only for FIFO queues.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`messageGroupIdStrategy(Object messageGroupIdStrategy)` Only for FIFO queues.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`messageGroupIdStrategy(String messageGroupIdStrategy)` Only for FIFO queues.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`messageRetentionPeriod(Integer messageRetentionPeriod)` The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`messageRetentionPeriod(String messageRetentionPeriod)` The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`operation(Sqs2EndpointBuilderFactory.Sqs2Operations operation)` The operation to do in case the user don't want to send only a message.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`operation(String operation)` The operation to do in case the user don't want to send only a message.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`policy(String policy)` The policy for this queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`protocol(String protocol)` The underlying protocol used to communicate with SQS.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`proxyPort(String proxyPort)` To define a proxy port when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`proxyProtocol(Sqs2EndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the SQS client.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`queueOwnerAWSAccountId(String queueOwnerAWSAccountId)` Specify the queue owner aws account id when you need to connect the queue with different account owner.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`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.Sqs2EndpointProducerBuilder`	`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.Sqs2EndpointProducerBuilder`	`redrivePolicy(String redrivePolicy)` Specify the policy that send message to DeadLetter queue.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`region(String region)` The region in which SQS client needs to work.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`trustAllCertificates(boolean trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder`	`trustAllCertificates(String trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.

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 Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointProducerBuilder advanced()
```
  - amazonAWSHost
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder autoCreateQueue(boolean autoCreateQueue)
```
    Setting the autocreation of the queue. The option is a: boolean type. Default: true Group: common
  - autoCreateQueue
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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
  - delaySeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder delaySeconds(Integer delaySeconds)
```
    Delay sending messages for a number of seconds. The option is a: java.lang.Integer type. Group: producer
  - delaySeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.aws2.sqs.MessageDeduplicationIdStrategy type. Default: useExchangeId Group: producer
  - messageDeduplicationIdStrategy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.aws2.sqs.MessageDeduplicationIdStrategy type. Default: useExchangeId Group: producer
  - messageGroupIdStrategy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.aws2.sqs.MessageGroupIdStrategy type. Group: producer
  - messageGroupIdStrategy
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.aws2.sqs.MessageGroupIdStrategy type. Group: producer
  - operation
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder operation(Sqs2EndpointBuilderFactory.Sqs2Operations 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.aws2.sqs.Sqs2Operations type. Group: producer
  - operation
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.aws2.sqs.Sqs2Operations type. Group: producer
  - proxyHost
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder policy(String policy)
```
    The policy for this queue. The option is a: java.lang.String type. Group: queue
  - receiveMessageWaitTimeSeconds
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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.Sqs2EndpointProducerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
  - secretKey
```
default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

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

trustAllCertificates

trustAllCertificates

delaySeconds

delaySeconds

lazyStartProducer

lazyStartProducer

messageDeduplicationIdStrategy

messageDeduplicationIdStrategy

messageGroupIdStrategy

messageGroupIdStrategy

operation

operation

proxyHost

proxyPort

proxyPort

maximumMessageSize

maximumMessageSize

messageRetentionPeriod

messageRetentionPeriod

policy

receiveMessageWaitTimeSeconds

receiveMessageWaitTimeSeconds

redrivePolicy

accessKey

secretKey