Interface SqsEndpointBuilderFactory.SqsEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
,SqsEndpointBuilderFactory.SqsEndpointProducerBuilder
- Enclosing interface:
- SqsEndpointBuilderFactory
public static interface SqsEndpointBuilderFactory.SqsEndpointBuilder extends SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder, SqsEndpointBuilderFactory.SqsEndpointProducerBuilder
Builder for endpoint for the AWS Simple Queue Service (SQS) component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SqsEndpointBuilderFactory.SqsEndpointBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default SqsEndpointBuilderFactory.AdvancedSqsEndpointBuilder
advanced()
default SqsEndpointBuilderFactory.SqsEndpointBuilder
amazonAWSHost(String amazonAWSHost)
The hostname of the Amazon AWS cloud.default SqsEndpointBuilderFactory.SqsEndpointBuilder
amazonSQSClient(Object amazonSQSClient)
To use the AmazonSQS as client.default SqsEndpointBuilderFactory.SqsEndpointBuilder
amazonSQSClient(String amazonSQSClient)
To use the AmazonSQS as client.default SqsEndpointBuilderFactory.SqsEndpointBuilder
autoCreateQueue(boolean autoCreateQueue)
Setting the autocreation of the queue.default SqsEndpointBuilderFactory.SqsEndpointBuilder
autoCreateQueue(String autoCreateQueue)
Setting the autocreation of the queue.default SqsEndpointBuilderFactory.SqsEndpointBuilder
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.SqsEndpointBuilder
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.SqsEndpointBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel.default SqsEndpointBuilderFactory.SqsEndpointBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel.default SqsEndpointBuilderFactory.SqsEndpointBuilder
maximumMessageSize(Integer maximumMessageSize)
The maximumMessageSize (in bytes) an SQS message can contain for this queue.default SqsEndpointBuilderFactory.SqsEndpointBuilder
maximumMessageSize(String maximumMessageSize)
The maximumMessageSize (in bytes) an SQS message can contain for this queue.default SqsEndpointBuilderFactory.SqsEndpointBuilder
messageRetentionPeriod(Integer messageRetentionPeriod)
The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.default SqsEndpointBuilderFactory.SqsEndpointBuilder
messageRetentionPeriod(String messageRetentionPeriod)
The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.default SqsEndpointBuilderFactory.SqsEndpointBuilder
policy(String policy)
The policy for this queue.default SqsEndpointBuilderFactory.SqsEndpointBuilder
protocol(String protocol)
The underlying protocol used to communicate with SQS.default SqsEndpointBuilderFactory.SqsEndpointBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the SQS client.default SqsEndpointBuilderFactory.SqsEndpointBuilder
proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SQS client.default SqsEndpointBuilderFactory.SqsEndpointBuilder
proxyPort(String proxyPort)
To define a proxy port when instantiating the SQS client.default SqsEndpointBuilderFactory.SqsEndpointBuilder
proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the SQS client.default SqsEndpointBuilderFactory.SqsEndpointBuilder
proxyProtocol(SqsEndpointBuilderFactory.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SQS client.default SqsEndpointBuilderFactory.SqsEndpointBuilder
queueOwnerAWSAccountId(String queueOwnerAWSAccountId)
Specify the queue owner aws account id when you need to connect the queue with different account owner.default SqsEndpointBuilderFactory.SqsEndpointBuilder
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.SqsEndpointBuilder
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.SqsEndpointBuilder
redrivePolicy(String redrivePolicy)
Specify the policy that send message to DeadLetter queue.default SqsEndpointBuilderFactory.SqsEndpointBuilder
region(String region)
Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL.default SqsEndpointBuilderFactory.SqsEndpointBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.-
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri
-
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
attributeNames, backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, concurrentConsumers, concurrentConsumers, defaultVisibilityTimeout, defaultVisibilityTimeout, delay, delay, deleteAfterRead, deleteAfterRead, deleteIfFiltered, deleteIfFiltered, extendMessageVisibility, extendMessageVisibility, greedy, greedy, initialDelay, initialDelay, kmsDataKeyReusePeriodSeconds, kmsDataKeyReusePeriodSeconds, kmsMasterKeyId, maxMessagesPerPoll, maxMessagesPerPoll, messageAttributeNames, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, serverSideEncryptionEnabled, serverSideEncryptionEnabled, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay, visibilityTimeout, visibilityTimeout, waitTimeSeconds, waitTimeSeconds
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SqsEndpointBuilderFactory.SqsEndpointProducerBuilder
delaySeconds, delaySeconds, lazyStartProducer, lazyStartProducer, messageDeduplicationIdStrategy, messageDeduplicationIdStrategy, messageGroupIdStrategy, messageGroupIdStrategy, operation, operation
-
-
-
-
Method Detail
-
advanced
default SqsEndpointBuilderFactory.AdvancedSqsEndpointBuilder advanced()
- Specified by:
advanced
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
advanced
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
amazonAWSHost
default SqsEndpointBuilderFactory.SqsEndpointBuilder amazonAWSHost(String amazonAWSHost)
The hostname of the Amazon AWS cloud. The option is a:java.lang.String
type. Default: amazonaws.com Group: common- Specified by:
amazonAWSHost
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
amazonAWSHost
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
amazonSQSClient
default SqsEndpointBuilderFactory.SqsEndpointBuilder amazonSQSClient(Object amazonSQSClient)
To use the AmazonSQS as client. The option is a:com.amazonaws.services.sqs.AmazonSQS
type. Group: common- Specified by:
amazonSQSClient
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
amazonSQSClient
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
amazonSQSClient
default SqsEndpointBuilderFactory.SqsEndpointBuilder amazonSQSClient(String amazonSQSClient)
To use the AmazonSQS as client. The option will be converted to acom.amazonaws.services.sqs.AmazonSQS
type. Group: common- Specified by:
amazonSQSClient
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
amazonSQSClient
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
autoCreateQueue
default SqsEndpointBuilderFactory.SqsEndpointBuilder autoCreateQueue(boolean autoCreateQueue)
Setting the autocreation of the queue. The option is a:boolean
type. Default: true Group: common- Specified by:
autoCreateQueue
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
autoCreateQueue
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
autoCreateQueue
default SqsEndpointBuilderFactory.SqsEndpointBuilder autoCreateQueue(String autoCreateQueue)
Setting the autocreation of the queue. The option will be converted to aboolean
type. Default: true Group: common- Specified by:
autoCreateQueue
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
autoCreateQueue
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
autoDiscoverClient
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
autoDiscoverClient
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
autoDiscoverClient
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
autoDiscoverClient
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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 aboolean
type. Default: true Group: common- Specified by:
autoDiscoverClient
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
autoDiscoverClient
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
headerFilterStrategy
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
headerFilterStrategy
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
headerFilterStrategy
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
headerFilterStrategy
default SqsEndpointBuilderFactory.SqsEndpointBuilder headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to map headers to/from Camel. The option will be converted to aorg.apache.camel.spi.HeaderFilterStrategy
type. Group: common- Specified by:
headerFilterStrategy
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
headerFilterStrategy
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
protocol
default SqsEndpointBuilderFactory.SqsEndpointBuilder protocol(String protocol)
The underlying protocol used to communicate with SQS. The option is a:java.lang.String
type. Default: https Group: common- Specified by:
protocol
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
protocol
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
proxyProtocol
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
proxyProtocol
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
proxyProtocol
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
proxyProtocol
default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the SQS client. The option will be converted to acom.amazonaws.Protocol
type. Default: HTTPS Group: common- Specified by:
proxyProtocol
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
proxyProtocol
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
queueOwnerAWSAccountId
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
queueOwnerAWSAccountId
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
queueOwnerAWSAccountId
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
region
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
region
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
region
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
proxyHost
default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyHost(String proxyHost)
To define a proxy host when instantiating the SQS client. The option is a:java.lang.String
type. Group: proxy- Specified by:
proxyHost
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
proxyHost
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
proxyPort
default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SQS client. The option is a:java.lang.Integer
type. Group: proxy- Specified by:
proxyPort
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
proxyPort
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
proxyPort
default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyPort(String proxyPort)
To define a proxy port when instantiating the SQS client. The option will be converted to ajava.lang.Integer
type. Group: proxy- Specified by:
proxyPort
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
proxyPort
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
maximumMessageSize
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
maximumMessageSize
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
maximumMessageSize
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
maximumMessageSize
default SqsEndpointBuilderFactory.SqsEndpointBuilder maximumMessageSize(String maximumMessageSize)
The maximumMessageSize (in bytes) an SQS message can contain for this queue. The option will be converted to ajava.lang.Integer
type. Group: queue- Specified by:
maximumMessageSize
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
maximumMessageSize
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
messageRetentionPeriod
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
messageRetentionPeriod
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
messageRetentionPeriod
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
messageRetentionPeriod
default SqsEndpointBuilderFactory.SqsEndpointBuilder messageRetentionPeriod(String messageRetentionPeriod)
The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. The option will be converted to ajava.lang.Integer
type. Group: queue- Specified by:
messageRetentionPeriod
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
messageRetentionPeriod
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
policy
default SqsEndpointBuilderFactory.SqsEndpointBuilder policy(String policy)
The policy for this queue. The option is a:java.lang.String
type. Group: queue- Specified by:
policy
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
policy
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
receiveMessageWaitTimeSeconds
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
receiveMessageWaitTimeSeconds
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
receiveMessageWaitTimeSeconds
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
receiveMessageWaitTimeSeconds
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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 ajava.lang.Integer
type. Group: queue- Specified by:
receiveMessageWaitTimeSeconds
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
receiveMessageWaitTimeSeconds
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
redrivePolicy
default SqsEndpointBuilderFactory.SqsEndpointBuilder 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- Specified by:
redrivePolicy
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
redrivePolicy
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
accessKey
default SqsEndpointBuilderFactory.SqsEndpointBuilder accessKey(String accessKey)
Amazon AWS Access Key. The option is a:java.lang.String
type. Group: security- Specified by:
accessKey
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
accessKey
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
secretKey
default SqsEndpointBuilderFactory.SqsEndpointBuilder secretKey(String secretKey)
Amazon AWS Secret Key. The option is a:java.lang.String
type. Group: security- Specified by:
secretKey
in interfaceSqsEndpointBuilderFactory.SqsEndpointConsumerBuilder
- Specified by:
secretKey
in interfaceSqsEndpointBuilderFactory.SqsEndpointProducerBuilder
-
-