blob: 7ac6db4ccceaf995208412ee1a0e0ac41a93ea12 [file] [log] [blame]
// kafka-connector options: START
[[camel-yammer-kafka-connector-sink]]
= camel-yammer-kafka-connector sink configuration
When using camel-yammer-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-yammer-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-yammer sink connector supports 16 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.function* | The function to use One of: [MESSAGES] [MY_FEED] [ALGO] [FOLLOWING] [SENT] [PRIVATE] [RECEIVED] [USERS] [CURRENT] | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.useJson* | Set to true if you want to use raw JSON rather than converting to POJOs. | false | ConfigDef.Importance.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 | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.requestor* | To use a specific requester to communicate with Yammer. | null | 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.accessToken* | The access token | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.consumerKey* | The consumer key | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.consumerSecret* | The consumer secret | null | ConfigDef.Importance.HIGH
| *camel.component.yammer.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 | ConfigDef.Importance.MEDIUM
| *camel.component.yammer.basicPropertyBinding* | 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.yammer.config* | To use a shared yammer configuration | null | ConfigDef.Importance.MEDIUM
| *camel.component.yammer.requestor* | To use a specific requester to communicate with Yammer. | null | ConfigDef.Importance.MEDIUM
| *camel.component.yammer.accessToken* | The access token | null | ConfigDef.Importance.MEDIUM
| *camel.component.yammer.consumerKey* | The consumer key | null | ConfigDef.Importance.MEDIUM
| *camel.component.yammer.consumerSecret* | The consumer secret | null | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END