blob: 19f221875fffa1f3f0627c1d59480eaeff225845 [file] [log] [blame]
// kafka-connector options: START
[[camel-twitter-timeline-kafka-connector-sink]]
= camel-twitter-timeline-kafka-connector sink configuration
When using camel-twitter-timeline-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-twitter-timeline-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-twitter-timeline sink connector supports 23 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.timelineType* | The timeline type to produce/consume. One of: [PUBLIC] [HOME] [USER] [MENTIONS] [RETWEETSOFME] [UNKNOWN] | null | HIGH
| *camel.sink.endpoint.user* | The username when using timelineType=user | 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.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.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.httpProxyHost* | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | null | MEDIUM
| *camel.sink.endpoint.httpProxyPassword* | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | null | MEDIUM
| *camel.sink.endpoint.httpProxyPort* | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | null | MEDIUM
| *camel.sink.endpoint.httpProxyUser* | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | null | MEDIUM
| *camel.sink.endpoint.accessToken* | The access token. Can also be configured on the TwitterComponent level instead. | null | MEDIUM
| *camel.sink.endpoint.accessTokenSecret* | The access secret. Can also be configured on the TwitterComponent level instead. | null | MEDIUM
| *camel.sink.endpoint.consumerKey* | The consumer key. Can also be configured on the TwitterComponent level instead. | null | MEDIUM
| *camel.sink.endpoint.consumerSecret* | The consumer secret. Can also be configured on the TwitterComponent level instead. | null | MEDIUM
| *camel.component.twitter-timeline.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.twitter-timeline.basicProperty Binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.twitter-timeline.httpProxyHost* | The http proxy host which can be used for the camel-twitter. | null | MEDIUM
| *camel.component.twitter-timeline.httpProxyPassword* | The http proxy password which can be used for the camel-twitter. | null | MEDIUM
| *camel.component.twitter-timeline.httpProxyPort* | The http proxy port which can be used for the camel-twitter. | null | MEDIUM
| *camel.component.twitter-timeline.httpProxyUser* | The http proxy user which can be used for the camel-twitter. | null | MEDIUM
| *camel.component.twitter-timeline.accessToken* | The access token | null | MEDIUM
| *camel.component.twitter-timeline.accessTokenSecret* | The access token secret | null | MEDIUM
| *camel.component.twitter-timeline.consumerKey* | The consumer key | null | MEDIUM
| *camel.component.twitter-timeline.consumerSecret* | The consumer secret | null | MEDIUM
|===
// kafka-connector options: END