Interface Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
-
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.sqs.Sqs2Component>
- All Known Implementing Classes:
Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilderImpl
- Enclosing interface:
- Aws2SqsComponentBuilderFactory
public static interface Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.sqs.Sqs2Component>
Builder for the AWS 2 Simple Queue Service (SQS) component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
amazonAWSHost(String amazonAWSHost)
The hostname of the Amazon AWS cloud.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
amazonSQSClient(software.amazon.awssdk.services.sqs.SqsClient amazonSQSClient)
To use the AmazonSQS as client.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
attributeNames(String attributeNames)
A list of attribute names to receive when consuming.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
autoCreateQueue(boolean autoCreateQueue)
Setting the autocreation of the queue.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
bridgeErrorHandler(boolean bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
concurrentConsumers(int concurrentConsumers)
Allows you to use multiple threads to poll the sqs queue to increase throughput.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
configuration(org.apache.camel.component.aws2.sqs.Sqs2Configuration configuration)
The AWS SQS default configuration.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
defaultVisibilityTimeout(Integer defaultVisibilityTimeout)
The default visibility timeout (in seconds).default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
delayQueue(boolean delayQueue)
Define if you want to apply delaySeconds option to the queue or on single messages.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
delaySeconds(Integer delaySeconds)
Delay sending messages for a number of seconds.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
deleteAfterRead(boolean deleteAfterRead)
Delete message from SQS after it has been read.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
deleteIfFiltered(boolean deleteIfFiltered)
Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
extendMessageVisibility(boolean extendMessageVisibility)
If enabled then a scheduled background task will keep extending the message visibility on SQS.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
kmsDataKeyReusePeriodSeconds(Integer kmsDataKeyReusePeriodSeconds)
The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
kmsMasterKeyId(String kmsMasterKeyId)
The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
maximumMessageSize(Integer maximumMessageSize)
The maximumMessageSize (in bytes) an SQS message can contain for this queue.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
messageAttributeNames(String messageAttributeNames)
A list of message attribute names to receive when consuming.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
messageDeduplicationIdStrategy(String messageDeduplicationIdStrategy)
Only for FIFO queues.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
messageGroupIdStrategy(String messageGroupIdStrategy)
Only for FIFO queues.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
messageRetentionPeriod(Integer messageRetentionPeriod)
The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
operation(org.apache.camel.component.aws2.sqs.Sqs2Operations operation)
The operation to do in case the user don't want to send only a message.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
policy(String policy)
The policy for this queue.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
protocol(String protocol)
The underlying protocol used to communicate with SQS.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the SQS client.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SQS client.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
To define a proxy protocol when instantiating the SQS client.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
queueOwnerAWSAccountId(String queueOwnerAWSAccountId)
Specify the queue owner aws account id when you need to connect the queue with different account owner.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
queueUrl(String queueUrl)
To define the queueUrl explicitly.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
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 Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
redrivePolicy(String redrivePolicy)
Specify the policy that send message to DeadLetter queue.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
region(String region)
The region in which SQS client needs to work.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the queue.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
trustAllCertificates(boolean trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
visibilityTimeout(Integer visibilityTimeout)
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder
waitTimeSeconds(Integer waitTimeSeconds)
Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response.-
Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
-
-
-
Method Detail
-
amazonAWSHost
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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 Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder amazonSQSClient(software.amazon.awssdk.services.sqs.SqsClient amazonSQSClient)
To use the AmazonSQS as client. The option is a:software.amazon.awssdk.services.sqs.SqsClient
type. Group: common
-
autoCreateQueue
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder autoCreateQueue(boolean autoCreateQueue)
Setting the autocreation of the queue. The option is a:boolean
type. Default: true Group: common
-
configuration
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder configuration(org.apache.camel.component.aws2.sqs.Sqs2Configuration configuration)
The AWS SQS default configuration. The option is a:org.apache.camel.component.aws2.sqs.Sqs2Configuration
type. Group: common
-
protocol
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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 Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder proxyProtocol(software.amazon.awssdk.core.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
-
queueOwnerAWSAccountId
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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 Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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 Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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
-
useDefaultCredentialsProvider
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. The option is a:boolean
type. Default: false Group: common
-
attributeNames
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder attributeNames(String attributeNames)
A list of attribute names to receive when consuming. Multiple names can be separated by comma. The option is a:java.lang.String
type. Group: consumer
-
bridgeErrorHandler
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a:boolean
type. Default: false Group: consumer
-
concurrentConsumers
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder concurrentConsumers(int concurrentConsumers)
Allows you to use multiple threads to poll the sqs queue to increase throughput. The option is a:int
type. Default: 1 Group: consumer
-
defaultVisibilityTimeout
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder defaultVisibilityTimeout(Integer defaultVisibilityTimeout)
The default visibility timeout (in seconds). The option is a:java.lang.Integer
type. Group: consumer
-
deleteAfterRead
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder deleteAfterRead(boolean deleteAfterRead)
Delete message from SQS after it has been read. The option is a:boolean
type. Default: true Group: consumer
-
deleteIfFiltered
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder deleteIfFiltered(boolean deleteIfFiltered)
Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage. The option is a:boolean
type. Default: true Group: consumer
-
extendMessageVisibility
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder extendMessageVisibility(boolean extendMessageVisibility)
If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. The option is a:boolean
type. Default: false Group: consumer
-
kmsDataKeyReusePeriodSeconds
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder kmsDataKeyReusePeriodSeconds(Integer kmsDataKeyReusePeriodSeconds)
The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). The option is a:java.lang.Integer
type. Group: consumer
-
kmsMasterKeyId
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder kmsMasterKeyId(String kmsMasterKeyId)
The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. The option is a:java.lang.String
type. Group: consumer
-
messageAttributeNames
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder messageAttributeNames(String messageAttributeNames)
A list of message attribute names to receive when consuming. Multiple names can be separated by comma. The option is a:java.lang.String
type. Group: consumer
-
serverSideEncryptionEnabled
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
Define if Server Side Encryption is enabled or not on the queue. The option is a:boolean
type. Default: false Group: consumer
-
visibilityTimeout
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder visibilityTimeout(Integer visibilityTimeout)
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. The option is a:java.lang.Integer
type. Group: consumer
-
waitTimeSeconds
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder waitTimeSeconds(Integer waitTimeSeconds)
Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. The option is a:java.lang.Integer
type. Group: consumer
-
delaySeconds
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder delaySeconds(Integer delaySeconds)
Delay sending messages for a number of seconds. The option is a:java.lang.Integer
type. Group: producer
-
lazyStartProducer
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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
-
messageDeduplicationIdStrategy
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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 is a:java.lang.String
type. Default: useExchangeId Group: producer
-
messageGroupIdStrategy
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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 is a:java.lang.String
type. Group: producer
-
operation
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder operation(org.apache.camel.component.aws2.sqs.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
-
autowiredEnabled
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a:boolean
type. Default: true Group: advanced
-
delayQueue
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder delayQueue(boolean delayQueue)
Define if you want to apply delaySeconds option to the queue or on single messages. The option is a:boolean
type. Default: false Group: advanced
-
queueUrl
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder queueUrl(String queueUrl)
To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. The option is a:java.lang.String
type. Group: advanced
-
proxyHost
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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 Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder proxyPort(Integer proxyPort)
To define a proxy port when instantiating the SQS client. The option is a:java.lang.Integer
type. Group: proxy
-
maximumMessageSize
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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
-
messageRetentionPeriod
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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
-
policy
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder policy(String policy)
The policy for this queue. The option is a:java.lang.String
type. Group: queue
-
receiveMessageWaitTimeSeconds
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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
-
redrivePolicy
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder 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 Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder accessKey(String accessKey)
Amazon AWS Access Key. The option is a:java.lang.String
type. Group: security
-
secretKey
default Aws2SqsComponentBuilderFactory.Aws2SqsComponentBuilder secretKey(String secretKey)
Amazon AWS Secret Key. The option is a:java.lang.String
type. Group: security
-
-