blob: 42146f32911c8032c7ba2d5a6e61bdb7d6899841 [file] [log] [blame]
// kafka-connector options: START
[[camel-avro-kafka-connector-sink]]
= camel-avro-kafka-connector sink configuration
When using camel-avro-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-avro-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-avro 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.transport* | Transport to use, can be either http or netty One of: [http] [netty] | null | HIGH
| *camel.sink.path.port* | Port number to use | null | HIGH
| *camel.sink.path.host* | Hostname to use | null | HIGH
| *camel.sink.path.messageName* | The name of the message to send. | null | MEDIUM
| *camel.sink.endpoint.protocol* | Avro protocol to use | null | MEDIUM
| *camel.sink.endpoint.protocolClassName* | Avro protocol to use defined by the FQN class name | null | MEDIUM
| *camel.sink.endpoint.protocolLocation* | Avro protocol location | null | MEDIUM
| *camel.sink.endpoint.reflectionProtocol* | If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected | false | MEDIUM
| *camel.sink.endpoint.singleParameter* | If true, consumer parameter won't be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message | false | MEDIUM
| *camel.sink.endpoint.uriAuthority* | Authority to use (username and password) | 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.avro.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.avro.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.avro.configuration* | To use a shared AvroConfiguration to configure options once | null | MEDIUM
|===
// kafka-connector options: END