Name | Default Value | Description |
|---|
initialDelay | 1000 | Milliseconds before the first poll starts |
period
| 1000
| If greater than 0, generate periodic events every period milliseconds. |
delay
| 500
| Milliseconds before the next poll |
timeUnit
| MILLISECONDS | time unit for initialDelay and delay options. |
useFixedDelay | true | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
pollStrategy | | 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. In other words the error occurred while the polling was gathering information, for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it. |
runLoggingLevel | TRACE | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. |
sendEmptyMessageWhenIdle | false | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. |
greedy | false | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. |
scheduler | | Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. The default implementation uses theScheduledExecutorService and there is a Quartz2, and Spring based which supports CRON expressions. Notice: If using a custom scheduler then the options for initialDelay, useFixedDelay, timeUnit, andscheduledExecutorService may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text #myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example. |
schedulerPropertiesscheduler.xxx | | To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. For example, to specify a cron value for the Spring based scheduler, use scheduler.cron. |
backoffMultiplier | 0 | 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 | 0 | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in |
backoffErrorThreshold | 0 | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |
