blob: d6986a48009e08972da27a7246be47a853635cc1 [file] [log] [blame]
// kafka-connector options: START
[[camel-spring-batch-kafka-connector-sink]]
= camel-spring-batch-kafka-connector sink configuration
When using camel-spring-batch-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-spring-batch-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-spring-batch sink connector supports 11 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.jobName* | The name of the Spring Batch job located in the registry. | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.jobFrom Header* | Explicitly defines if the jobName should be taken from the headers instead of the URI. | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.job Launcher* | Explicitly specifies a JobLauncher to be used. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.job Registry* | Explicitly specifies a JobRegistry to be used. | null | ConfigDef.Importance.MEDIUM
| *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.component.spring-batch.job Launcher* | Explicitly specifies a JobLauncher to be used. | null | ConfigDef.Importance.MEDIUM
| * camel.component.spring-batch.job Registry* | Explicitly specifies a JobRegistry to be used. | null | ConfigDef.Importance.MEDIUM
| * camel.component.spring-batch.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.spring-batch.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
|===
// kafka-connector options: END