Interface FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
FlatpackEndpointBuilderFactory.FlatpackEndpointBuilder
- Enclosing interface:
- FlatpackEndpointBuilderFactory
public static interface FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Flatpack component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
allowShortLines
(boolean allowShortLines) Allows for lines to be shorter than expected and ignores the extra characters.allowShortLines
(String allowShortLines) Allows for lines to be shorter than expected and ignores the extra characters.backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.delimiter
(char delimiter) The default character delimiter for delimited files.The default character delimiter for delimited files.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.ignoreExtraColumns
(boolean ignoreExtraColumns) Allows for lines to be longer than expected and ignores the extra characters.ignoreExtraColumns
(String ignoreExtraColumns) Allows for lines to be longer than expected and ignores the extra characters.ignoreFirstRecord
(boolean ignoreFirstRecord) Whether the first line is ignored for delimited files (for the column headers).ignoreFirstRecord
(String ignoreFirstRecord) Whether the first line is ignored for delimited files (for the column headers).initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.sendEmptyMessageWhenIdle
(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.sendEmptyMessageWhenIdle
(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.splitRows
(boolean splitRows) Sets the Component to send each row as a separate exchange once parsed.Sets the Component to send each row as a separate exchange once parsed.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.textQualifier
(char textQualifier) The text qualifier for delimited files.textQualifier
(String textQualifier) The text qualifier for delimited files.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
allowShortLines
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder allowShortLines(boolean allowShortLines) Allows for lines to be shorter than expected and ignores the extra characters. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
allowShortLines
- the value to set- Returns:
- the dsl builder
-
allowShortLines
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder allowShortLines(String allowShortLines) Allows for lines to be shorter than expected and ignores the extra characters. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
allowShortLines
- the value to set- Returns:
- the dsl builder
-
delimiter
The default character delimiter for delimited files. The option is a: <code>char</code> type. Default: , Group: common- Parameters:
delimiter
- the value to set- Returns:
- the dsl builder
-
delimiter
The default character delimiter for delimited files. The option will be converted to a <code>char</code> type. Default: , Group: common- Parameters:
delimiter
- the value to set- Returns:
- the dsl builder
-
ignoreExtraColumns
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreExtraColumns(boolean ignoreExtraColumns) Allows for lines to be longer than expected and ignores the extra characters. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
ignoreExtraColumns
- the value to set- Returns:
- the dsl builder
-
ignoreExtraColumns
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreExtraColumns(String ignoreExtraColumns) Allows for lines to be longer than expected and ignores the extra characters. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
ignoreExtraColumns
- the value to set- Returns:
- the dsl builder
-
ignoreFirstRecord
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreFirstRecord(boolean ignoreFirstRecord) Whether the first line is ignored for delimited files (for the column headers). The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
ignoreFirstRecord
- the value to set- Returns:
- the dsl builder
-
ignoreFirstRecord
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreFirstRecord(String ignoreFirstRecord) Whether the first line is ignored for delimited files (for the column headers). The option will be converted to a <code>boolean</code> type. Default: true Group: common- Parameters:
ignoreFirstRecord
- the value to set- Returns:
- the dsl builder
-
splitRows
Sets the Component to send each row as a separate exchange once parsed. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
splitRows
- the value to set- Returns:
- the dsl builder
-
splitRows
Sets the Component to send each row as a separate exchange once parsed. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Parameters:
splitRows
- the value to set- Returns:
- the dsl builder
-
textQualifier
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder textQualifier(char textQualifier) The text qualifier for delimited files. The option is a: <code>char</code> type. Group: common- Parameters:
textQualifier
- the value to set- Returns:
- the dsl builder
-
textQualifier
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder textQualifier(String textQualifier) The text qualifier for delimited files. The option will be converted to a <code>char</code> type. Group: common- Parameters:
textQualifier
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier) 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. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier) 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. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder initialDelay(long initialDelay) Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
initialDelay
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder initialDelay(String initialDelay) Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
repeatCount
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder repeatCount(long repeatCount) Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
repeatCount
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder repeatCount(String repeatCount) Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
schedulerProperties
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder startScheduler(boolean startScheduler) Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
startScheduler
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder startScheduler(String startScheduler) Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-