Defines the AWS SQS Endpoint.
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
queueName | path | java.lang.String | true | false | Name of queue. The queue will be created if they don't already exists. | ||
amazonSQSClient | parameter | com.amazonaws.services.sqs.AmazonSQS | false | To use the AmazonSQS as client | |||
accessKey | parameter | java.lang.String | false | Amazon AWS Access Key | |||
secretKey | parameter | java.lang.String | false | Amazon AWS Secret Key | |||
amazonSQSEndpoint | parameter | java.lang.String | false | The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client, i.e., if you explicitly set amazonSQSClient, then this setting will have no effect. You would have to set it on the client you create directly | |||
queueOwnerAWSAccountId | parameter | java.lang.String | false | Specify the queue owner aws account id when you need to connect the queue with different account owner. | |||
region | parameter | java.lang.String | false | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. | |||
proxyHost | parameter | java.lang.String | false | To define a proxy host when instantiating the SQS client | |||
proxyPort | parameter | java.lang.Integer | false | To define a proxy port when instantiating the SQS client | |||
deleteAfterRead | parameter | boolean | false | true | Delete message from SQS after it has been read | ||
deleteIfFiltered | parameter | boolean | false | true | 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. | ||
visibilityTimeout | parameter | java.lang.Integer | false | 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. | |||
attributeNames | parameter | java.util.Collection |
false | A list of attribute names to receive when consuming | |||
messageAttributeNames | parameter | java.util.Collection |
false | A list of message attribute names to receive when consuming | |||
waitTimeSeconds | parameter | java.lang.Integer | false | 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. | |||
defaultVisibilityTimeout | parameter | java.lang.Integer | false | The default visibility timeout (in seconds) | |||
extendMessageVisibility | parameter | boolean | false | 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. | |||
concurrentConsumers | parameter | int | false | 1 | Allows you to use multiple threads to poll the sqs queue to increase throughput | ||
delaySeconds | parameter | java.lang.Integer | false | Delay sending messages for a number of seconds. | |||
maximumMessageSize | parameter | java.lang.Integer | false | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | |||
messageRetentionPeriod | parameter | java.lang.Integer | false | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | |||
receiveMessageWaitTimeSeconds | parameter | java.lang.Integer | false | If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | |||
policy | parameter | java.lang.String | false | The policy for this queue | |||
redrivePolicy | parameter | java.lang.String | false | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | |||
maxMessagesPerPoll | parameter | int | false | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. | |||
headerFilterStrategy | parameter | org.apache.camel.spi.HeaderFilterStrategy | false | To use a custom HeaderFilterStrategy to map headers to/from Camel. | |||
startScheduler | parameter | boolean | false | true | Whether the scheduler should be auto started. | ||
initialDelay | parameter | long | false | 1000 | Milliseconds before the first poll starts. | ||
delay | parameter | long | false | 500 | Milliseconds before the next poll. | ||
timeUnit | parameter | java.util.concurrent.TimeUnit | false | MILLISECONDS | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
Time unit for initialDelay and delay options. | |
useFixedDelay | parameter | boolean | false | true | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | ||
pollStrategy | parameter | org.apache.camel.spi.PollingConsumerPollStrategy | false | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | |||
runLoggingLevel | parameter | org.apache.camel.LoggingLevel | false | TRACE | TRACE DEBUG INFO WARN ERROR OFF |
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | |
sendEmptyMessageWhenIdle | parameter | boolean | false | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | |||
greedy | parameter | boolean | false | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | |||
scheduler | parameter | org.apache.camel.spi.ScheduledPollConsumerScheduler | false | spring quartz2 |
To use a cron scheduler from either camel-spring or camel-quartz2 component | ||
schedulerProperties | parameter | java.util.Map |
false | To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. | |||
scheduledExecutorService | parameter | java.util.concurrent.ScheduledExecutorService | false | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | |||
backoffMultiplier | parameter | int | false | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | |||
backoffIdleThreshold | parameter | int | false | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | |||
backoffErrorThreshold | parameter | int | false | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | |||
exchangePattern | parameter | org.apache.camel.ExchangePattern | false | InOnly | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the default exchange pattern when creating an exchange | |
synchronous | parameter | boolean | false | false | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
A Consumer of messages from the Amazon Web Service Simple Queue Service AWS SQS
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
maxMessagesPerPoll | parameter | int | false |