blob: bd85473c3ac8e913a84376b93ca47959a12c728e [file] [log] [blame]
// kafka-connector options: START
[[camel-vertx-kafka-connector-sink]]
= camel-vertx-kafka-connector sink configuration
When using camel-vertx-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-vertx-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-vertx sink connector supports 13 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.address* | Sets the event bus address used to communicate | null | HIGH
| *camel.sink.endpoint.pubSub* | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. | 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.component.vertx.host* | Hostname for creating an embedded clustered EventBus | null | MEDIUM
| *camel.component.vertx.port* | Port for creating an embedded clustered EventBus | null | MEDIUM
| *camel.component.vertx.timeout* | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. | 60 | MEDIUM
| *camel.component.vertx.vertx* | To use the given vertx EventBus instead of creating a new embedded EventBus | null | MEDIUM
| *camel.component.vertx.vertxOptions* | Options to use for creating vertx | null | MEDIUM
| *camel.component.vertx.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.vertx.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.vertx.vertxFactory* | To use a custom VertxFactory implementation | null | MEDIUM
|===
// kafka-connector options: END