org.apache.camel.builder.endpoint.dsl

Interface Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder, Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

Enclosing interface:

Sqs2EndpointBuilderFactory

public static interface Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder
extends Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder, Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

Builder for endpoint for the AWS 2 Simple Queue Service (SQS) component.

Method Summary

Modifier and Type	Method and Description
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointBuilder	advanced()
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	amazonAWSHost(String amazonAWSHost) The hostname of the Amazon AWS cloud.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	amazonSQSClient(Object amazonSQSClient) To use the AmazonSQS as client.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	amazonSQSClient(String amazonSQSClient) To use the AmazonSQS as client.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	autoCreateQueue(boolean autoCreateQueue) Setting the autocreation of the queue.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	autoCreateQueue(String autoCreateQueue) Setting the autocreation of the queue.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	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.Sqs2EndpointBuilder	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.Sqs2EndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to map headers to/from Camel.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to map headers to/from Camel.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	maximumMessageSize(Integer maximumMessageSize) The maximumMessageSize (in bytes) an SQS message can contain for this queue.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	maximumMessageSize(String maximumMessageSize) The maximumMessageSize (in bytes) an SQS message can contain for this queue.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	messageRetentionPeriod(Integer messageRetentionPeriod) The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	messageRetentionPeriod(String messageRetentionPeriod) The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	policy(String policy) The policy for this queue.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	protocol(String protocol) The underlying protocol used to communicate with SQS.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the SQS client.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the SQS client.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	proxyPort(String proxyPort) To define a proxy port when instantiating the SQS client.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	proxyProtocol(Sqs2EndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the SQS client.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the SQS client.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	queueOwnerAWSAccountId(String queueOwnerAWSAccountId) Specify the queue owner aws account id when you need to connect the queue with different account owner.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	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.Sqs2EndpointBuilder	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.Sqs2EndpointBuilder	redrivePolicy(String redrivePolicy) Specify the policy that send message to DeadLetter queue.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	region(String region) The region in which SQS client needs to work.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	secretKey(String secretKey) Amazon AWS Secret Key.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	trustAllCertificates(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.
default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder	trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

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.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

delaySeconds, delaySeconds, lazyStartProducer, lazyStartProducer, messageDeduplicationIdStrategy, messageDeduplicationIdStrategy, messageGroupIdStrategy, messageGroupIdStrategy, operation, operation

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.AdvancedSqs2EndpointBuilder advanced()

Specified by:

advanced in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

advanced in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

amazonAWSHost

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

amazonAWSHost in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

amazonSQSClient

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder amazonSQSClient(Object amazonSQSClient)

To use the AmazonSQS as client. The option is a: software.amazon.awssdk.services.sqs.SqsClient type. Group: common

Specified by:

amazonSQSClient in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

amazonSQSClient in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

amazonSQSClient

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

amazonSQSClient in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

amazonSQSClient in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

autoCreateQueue

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder autoCreateQueue(boolean autoCreateQueue)

Setting the autocreation of the queue. The option is a: boolean type. Default: true Group: common

Specified by:

autoCreateQueue in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

autoCreateQueue in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

autoCreateQueue

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder autoCreateQueue(String autoCreateQueue)

Setting the autocreation of the queue. The option will be converted to a boolean type. Default: true Group: common

Specified by:

autoCreateQueue in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

autoCreateQueue in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

autoDiscoverClient

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

autoDiscoverClient in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

autoDiscoverClient

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

autoDiscoverClient in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

autoDiscoverClient in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

headerFilterStrategy

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

headerFilterStrategy

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

headerFilterStrategy in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

protocol

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

protocol in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

proxyProtocol

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

proxyProtocol in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

proxyProtocol in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

proxyProtocol

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

proxyProtocol in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

proxyProtocol in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

queueOwnerAWSAccountId

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

queueOwnerAWSAccountId in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

region

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

region in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

region in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

trustAllCertificates

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

trustAllCertificates in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

trustAllCertificates in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

trustAllCertificates

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

trustAllCertificates in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

trustAllCertificates in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

proxyHost

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

proxyHost in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

proxyPort

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

proxyPort in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

proxyPort

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

proxyPort in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

proxyPort in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

maximumMessageSize

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

maximumMessageSize in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

maximumMessageSize

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

maximumMessageSize in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

maximumMessageSize in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

messageRetentionPeriod

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

messageRetentionPeriod in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

messageRetentionPeriod

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

messageRetentionPeriod in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

messageRetentionPeriod in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

policy

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder policy(String policy)

The policy for this queue. The option is a: java.lang.String type. Group: queue

Specified by:

policy in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

policy in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

receiveMessageWaitTimeSeconds

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

receiveMessageWaitTimeSeconds in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

receiveMessageWaitTimeSeconds

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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

Specified by:

receiveMessageWaitTimeSeconds in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

receiveMessageWaitTimeSeconds in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

redrivePolicy

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder 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 interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

redrivePolicy in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

accessKey

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder accessKey(String accessKey)

Amazon AWS Access Key. The option is a: java.lang.String type. Group: security

Specified by:

accessKey in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

accessKey in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

secretKey

default Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder secretKey(String secretKey)

Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Specified by:

secretKey in interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

Specified by:

secretKey in interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder