org.apache.camel.builder.endpoint.dsl

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

Modifier and Type	Method and 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	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 TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder	bridgeErrorHandler(String 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 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(TelegramEndpointBuilderFactory.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(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder	scheduledExecutorService(String 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(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
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	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.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default TelegramEndpointBuilderFactory.AdvancedTelegramEndpointConsumerBuilder advanced()

bridgeErrorHandler

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder 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

bridgeErrorHandler

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a boolean type. Default: false Group: consumer

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: java.lang.Integer type. Default: 100 Group: consumer

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 java.lang.Integer type. Default: 100 Group: consumer

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: boolean type. Default: false Group: consumer

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 boolean type. Default: false Group: consumer

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: java.lang.Integer type. Default: 30 Group: consumer

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 java.lang.Integer type. Default: 30 Group: consumer

proxyHost

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder proxyHost(String proxyHost)

HTTP proxy host which could be used when sending out the message. The option is a: java.lang.String type. Group: proxy

proxyPort

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder proxyPort(Integer proxyPort)

HTTP proxy port which could be used when sending out the message. The option is a: java.lang.Integer type. Group: proxy

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 java.lang.Integer type. Group: proxy

proxyType

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder proxyType(TelegramEndpointBuilderFactory.TelegramProxyType proxyType)

HTTP proxy type which could be used when sending out the message. The option is a: org.apache.camel.component.telegram.TelegramProxyType type. Default: HTTP Group: proxy

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 org.apache.camel.component.telegram.TelegramProxyType type. Default: HTTP Group: proxy

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: int type. Group: scheduler

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 int type. Group: scheduler

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: int type. Group: scheduler

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 int type. Group: scheduler

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: int type. Group: scheduler

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 int type. Group: scheduler

delay

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder delay(long delay)

Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler

delay

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder delay(String delay)

Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler

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: boolean type. Default: false Group: scheduler

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 boolean type. Default: false Group: scheduler

initialDelay

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder initialDelay(long initialDelay)

Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler

initialDelay

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder initialDelay(String initialDelay)

Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler

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: long type. Default: 0 Group: scheduler

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 long type. Default: 0 Group: scheduler

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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler

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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler

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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler

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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler

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: java.lang.Object type. Default: none Group: scheduler

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 java.lang.Object type. Default: none Group: scheduler

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: java.util.Map<java.lang.String, java.lang.Object> 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

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: java.util.Map<java.lang.String, java.lang.Object> 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

startScheduler

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder startScheduler(boolean startScheduler)

Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler

startScheduler

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder startScheduler(String startScheduler)

Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler

timeUnit

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)

Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler

timeUnit

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder timeUnit(String timeUnit)

Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler

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: boolean type. Default: true Group: scheduler

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 boolean type. Default: true Group: scheduler

authorizationToken

default TelegramEndpointBuilderFactory.TelegramEndpointConsumerBuilder authorizationToken(String authorizationToken)

The authorization token for using the bot (ask the BotFather). The option is a: java.lang.String type. Required: true Group: security