Interface TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
TelegramEndpointBuilderFactory.TelegramEndpointBuilder
- Enclosing interface:
- TelegramEndpointBuilderFactory
public static interface TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Telegram component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default TelegramEndpointBuilderFactory.AdvancedTelegramEndpointConsumerBuilder
advanced()
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
authorizationToken(String authorizationToken)
The authorization token for using the bot (ask the BotFather).default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
delay(long delay)
Milliseconds before the next poll.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
delay(String delay)
Milliseconds before the next poll.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
limit(Integer limit)
Limit on the number of updates that can be received in a single polling request.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
limit(String limit)
Limit on the number of updates that can be received in a single polling request.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
proxyHost(String proxyHost)
HTTP proxy host which could be used when sending out the message.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
proxyPort(Integer proxyPort)
HTTP proxy port which could be used when sending out the message.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
proxyPort(String proxyPort)
HTTP proxy port which could be used when sending out the message.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
proxyType(String proxyType)
HTTP proxy type which could be used when sending out the message.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
proxyType(org.apache.camel.component.telegram.TelegramProxyType proxyType)
HTTP proxy type which could be used when sending out the message.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
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.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
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.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
timeout(Integer timeout)
Timeout in seconds for long polling.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
timeout(String timeout)
Timeout in seconds for long polling.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.
-
-
-
Method Detail
-
advanced
default TelegramEndpointBuilderFactory.AdvancedTelegramEndpointConsumerBuilder advanced()
-
limit
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder limit(Integer limit)
Limit on the number of updates that can be received in a single polling request. The option is a: <code>java.lang.Integer</code> type. Default: 100 Group: consumer- Parameters:
limit
- the value to set- Returns:
- the dsl builder
-
limit
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder limit(String limit)
Limit on the number of updates that can be received in a single polling request. The option will be converted to a <code>java.lang.Integer</code> type. Default: 100 Group: consumer- Parameters:
limit
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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
-
timeout
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder timeout(Integer timeout)
Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time. The option is a: <code>java.lang.Integer</code> type. Default: 30 Group: consumer- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
timeout
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder timeout(String timeout)
Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time. The option will be converted to a <code>java.lang.Integer</code> type. Default: 30 Group: consumer- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
proxyHost
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder proxyHost(String proxyHost)
HTTP proxy host which could be used when sending out the message. The option is a: <code>java.lang.String</code> type. Group: proxy- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder proxyPort(Integer proxyPort)
HTTP proxy port which could be used when sending out the message. The option is a: <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder proxyPort(String proxyPort)
HTTP proxy port which could be used when sending out the message. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyType
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder proxyType(org.apache.camel.component.telegram.TelegramProxyType proxyType)
HTTP proxy type which could be used when sending out the message. The option is a: <code>org.apache.camel.component.telegram.TelegramProxyType</code> type. Default: HTTP Group: proxy- Parameters:
proxyType
- the value to set- Returns:
- the dsl builder
-
proxyType
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder proxyType(String proxyType)
HTTP proxy type which could be used when sending out the message. The option will be converted to a <code>org.apache.camel.component.telegram.TelegramProxyType</code> type. Default: HTTP Group: proxy- Parameters:
proxyType
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder delay(long 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
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder delay(String 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
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder greedy(boolean 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
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder greedy(String 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder scheduler(Object 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
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder scheduler(String 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder timeUnit(TimeUnit 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
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder timeUnit(String 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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
-
authorizationToken
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder authorizationToken(String authorizationToken)
The authorization token for using the bot (ask the BotFather). The option is a: <code>java.lang.String</code> type. Required: true Group: security- Parameters:
authorizationToken
- the value to set- Returns:
- the dsl builder
-
-