org.apache.camel.builder.endpoint.dsl

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

Modifier and Type	Method and 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(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to map headers to/from Camel.
default SqsEndpointBuilderFactory.SqsEndpointBuilder	headerFilterStrategy(String 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(SqsEndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the SQS client.
default SqsEndpointBuilderFactory.SqsEndpointBuilder	proxyProtocol(String 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.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.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.SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

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

Specified by:

advanced in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

advanced in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

amazonAWSHost

default SqsEndpointBuilderFactory.SqsEndpointBuilder amazonAWSHost(String amazonAWSHost)

The hostname of the Amazon AWS cloud. The option is a: <code>java.lang.String</code> type. Default: amazonaws.com Group: common

Specified by:

amazonAWSHost in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

amazonAWSHost in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

amazonAWSHost - the value to set

Returns:

the dsl builder

amazonSQSClient

default SqsEndpointBuilderFactory.SqsEndpointBuilder amazonSQSClient(Object amazonSQSClient)

To use the AmazonSQS as client. The option is a: <code>com.amazonaws.services.sqs.AmazonSQS</code> type. Group: common

Specified by:

amazonSQSClient in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

amazonSQSClient in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

amazonSQSClient - the value to set

Returns:

the dsl builder

amazonSQSClient

default SqsEndpointBuilderFactory.SqsEndpointBuilder amazonSQSClient(String amazonSQSClient)

To use the AmazonSQS as client. The option will be converted to a <code>com.amazonaws.services.sqs.AmazonSQS</code> type. Group: common

Specified by:

amazonSQSClient in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

amazonSQSClient in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

amazonSQSClient - the value to set

Returns:

the dsl builder

autoCreateQueue

default SqsEndpointBuilderFactory.SqsEndpointBuilder autoCreateQueue(boolean autoCreateQueue)

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

Specified by:

autoCreateQueue in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

autoCreateQueue in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

autoCreateQueue - the value to set

Returns:

the dsl builder

autoCreateQueue

default SqsEndpointBuilderFactory.SqsEndpointBuilder autoCreateQueue(String autoCreateQueue)

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

Specified by:

autoCreateQueue in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

autoCreateQueue in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

autoCreateQueue - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: true Group: common

Specified by:

autoDiscoverClient in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

autoDiscoverClient in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

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 a <code>boolean</code> type. Default: true Group: common

Specified by:

autoDiscoverClient in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

autoDiscoverClient in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

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: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common

Specified by:

headerFilterStrategy in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default SqsEndpointBuilderFactory.SqsEndpointBuilder headerFilterStrategy(String headerFilterStrategy)

To use a custom HeaderFilterStrategy to map headers to/from Camel. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common

Specified by:

headerFilterStrategy in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

protocol

default SqsEndpointBuilderFactory.SqsEndpointBuilder protocol(String protocol)

The underlying protocol used to communicate with SQS. The option is a: <code>java.lang.String</code> type. Default: https Group: common

Specified by:

protocol in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

protocol in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

protocol - the value to set

Returns:

the dsl builder

proxyProtocol

default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyProtocol(SqsEndpointBuilderFactory.Protocol proxyProtocol)

To define a proxy protocol when instantiating the SQS client. The option is a: <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: common

Specified by:

proxyProtocol in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

proxyProtocol in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

proxyProtocol

default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyProtocol(String proxyProtocol)

To define a proxy protocol when instantiating the SQS client. The option will be converted to a <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: common

Specified by:

proxyProtocol in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

proxyProtocol in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

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: <code>java.lang.String</code> type. Group: common

Specified by:

queueOwnerAWSAccountId in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

queueOwnerAWSAccountId in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

queueOwnerAWSAccountId - the value to set

Returns:

the dsl builder

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: <code>java.lang.String</code> type. Group: common

Specified by:

region in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

region in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

region - the value to set

Returns:

the dsl builder

proxyHost

default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the SQS client. The option is a: <code>java.lang.String</code> type. Group: proxy

Specified by:

proxyHost in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

proxyHost in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

proxyHost - the value to set

Returns:

the dsl builder

proxyPort

default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyPort(Integer proxyPort)

To define a proxy port when instantiating the SQS client. The option is a: <code>java.lang.Integer</code> type. Group: proxy

Specified by:

proxyPort in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

proxyPort in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyPort

default SqsEndpointBuilderFactory.SqsEndpointBuilder proxyPort(String proxyPort)

To define a proxy port when instantiating the SQS client. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy

Specified by:

proxyPort in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

proxyPort in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

maximumMessageSize

default SqsEndpointBuilderFactory.SqsEndpointBuilder maximumMessageSize(Integer maximumMessageSize)

The maximumMessageSize (in bytes) an SQS message can contain for this queue. The option is a: <code>java.lang.Integer</code> type. Group: queue

Specified by:

maximumMessageSize in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

maximumMessageSize in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

maximumMessageSize - the value to set

Returns:

the dsl builder

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 a <code>java.lang.Integer</code> type. Group: queue

Specified by:

maximumMessageSize in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

maximumMessageSize in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

maximumMessageSize - the value to set

Returns:

the dsl builder

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: <code>java.lang.Integer</code> type. Group: queue

Specified by:

messageRetentionPeriod in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

messageRetentionPeriod in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

messageRetentionPeriod - the value to set

Returns:

the dsl builder

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 a <code>java.lang.Integer</code> type. Group: queue

Specified by:

messageRetentionPeriod in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

messageRetentionPeriod in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

messageRetentionPeriod - the value to set

Returns:

the dsl builder

policy

default SqsEndpointBuilderFactory.SqsEndpointBuilder policy(String policy)

The policy for this queue. The option is a: <code>java.lang.String</code> type. Group: queue

Specified by:

policy in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

policy in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

policy - the value to set

Returns:

the dsl builder

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: <code>java.lang.Integer</code> type. Group: queue

Specified by:

receiveMessageWaitTimeSeconds in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

receiveMessageWaitTimeSeconds in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

receiveMessageWaitTimeSeconds - the value to set

Returns:

the dsl builder

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 a <code>java.lang.Integer</code> type. Group: queue

Specified by:

receiveMessageWaitTimeSeconds in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

receiveMessageWaitTimeSeconds in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

receiveMessageWaitTimeSeconds - the value to set

Returns:

the dsl builder

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: <code>java.lang.String</code> type. Group: queue

Specified by:

redrivePolicy in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

redrivePolicy in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

redrivePolicy - the value to set

Returns:

the dsl builder

accessKey

default SqsEndpointBuilderFactory.SqsEndpointBuilder accessKey(String accessKey)

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

Specified by:

accessKey in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

accessKey in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

accessKey - the value to set

Returns:

the dsl builder

secretKey

default SqsEndpointBuilderFactory.SqsEndpointBuilder secretKey(String secretKey)

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

Specified by:

secretKey in interface SqsEndpointBuilderFactory.SqsEndpointConsumerBuilder

Specified by:

secretKey in interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

Parameters:

secretKey - the value to set

Returns:

the dsl builder