blob: eb502463f8aa91e79b2012a87057d28366009bfe [file] [log] [blame]
// kafka-connector options: START
[[camel-telegram-kafka-connector-sink]]
= camel-telegram-kafka-connector sink configuration
When using camel-telegram-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-telegram-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-telegram sink connector supports 17 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.type* | The endpoint type. Currently, only the 'bots' type is supported. One of: [bots] | null | HIGH
| *camel.sink.endpoint.chatId* | The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot, its client sends automatically a '/start' message containing the chat id). It is an optional parameter, as the chat id can be set dynamically for each outgoing message (using body or headers). | null | MEDIUM
| *camel.sink.endpoint.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.sink.endpoint.baseUri* | Can be used to set an alternative base URI, e.g. when you want to test the component against a mock Telegram API | null | MEDIUM
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.bufferSize* | The initial in-memory buffer size used when transferring data between Camel and AHC Client. | 4096 | MEDIUM
| *camel.sink.endpoint.clientConfig* | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | null | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.proxyHost* | HTTP proxy host which could be used when sending out the message. | null | MEDIUM
| *camel.sink.endpoint.proxyPort* | HTTP proxy port which could be used when sending out the message. | null | MEDIUM
| *camel.sink.endpoint.authorizationToken* | The authorization token for using the bot (ask the BotFather) | null | HIGH
| *camel.component.telegram.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.component.telegram.baseUri* | Can be used to set an alternative base URI, e.g. when you want to test the component against a mock Telegram API | "https://api.telegram.org" | MEDIUM
| *camel.component.telegram.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.telegram.client* | To use a custom AsyncHttpClient | null | MEDIUM
| *camel.component.telegram.clientConfig* | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | null | MEDIUM
| *camel.component.telegram.authorizationToken* | The default Telegram authorization token to be used when the information is not provided in the endpoints. | null | MEDIUM
|===
// kafka-connector options: END