blob: 3deca9aff16d39147ef2031aec377c05b2374841 [file] [log] [blame]
// kafka-connector options: START
[[camel-twitter-directmessage-kafka-connector-sink]]
= camel-twitter-directmessage-kafka-connector sink configuration
When using camel-twitter-directmessage-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-directmessage-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-twitter-directmessage sink connector supports 22 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.user* | The user name to send a direct message. This will be ignored for consumer. | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.lazyStart Producer* | 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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.httpProxy Host* | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.httpProxy Password* | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.httpProxy Port* | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.httpProxy User* | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.access Token* | The access token. Can also be configured on the TwitterComponent level instead. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.access TokenSecret* | The access secret. Can also be configured on the TwitterComponent level instead. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.consumer Key* | The consumer key. Can also be configured on the TwitterComponent level instead. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.consumer Secret* | The consumer secret. Can also be configured on the TwitterComponent level instead. | null | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.lazy StartProducer* | 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 | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.http ProxyHost* | The http proxy host which can be used for the camel-twitter. | null | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.http ProxyPassword* | The http proxy password which can be used for the camel-twitter. | null | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.http ProxyPort* | The http proxy port which can be used for the camel-twitter. | null | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.http ProxyUser* | The http proxy user which can be used for the camel-twitter. | null | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.access Token* | The access token | null | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.access TokenSecret* | The access token secret | null | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.consumer Key* | The consumer key | null | ConfigDef.Importance.MEDIUM
| * camel.component.twitter-directmessage.consumer Secret* | The consumer secret | null | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END