camel-consul-kafka-connector sink configuration

When using camel-consul-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-consul-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.consul.CamelConsulSinkConnector

The camel-consul sink connector supports 50 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.apiEndpoint	The API endpoint	null	true	HIGH
camel.sink.endpoint.connectTimeout	Connect timeout for OkHttpClient	null	false	MEDIUM
camel.sink.endpoint.connectTimeoutMillis	Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead	null	false	LOW
camel.sink.endpoint.consulClient	Reference to a com.orbitz.consul.Consul in the registry.	null	false	MEDIUM
camel.sink.endpoint.key	The default key. Can be overridden by CamelConsulKey	null	false	MEDIUM
camel.sink.endpoint.pingInstance	Configure if the AgentClient should attempt a ping before returning the Consul instance	true	false	MEDIUM
camel.sink.endpoint.readTimeout	Read timeout for OkHttpClient	null	false	MEDIUM
camel.sink.endpoint.readTimeoutMillis	Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead	null	false	LOW
camel.sink.endpoint.tags	Set tags. You can separate multiple tags by comma.	null	false	MEDIUM
camel.sink.endpoint.url	The Consul agent URL	null	false	MEDIUM
camel.sink.endpoint.writeTimeout	Write timeout for OkHttpClient	null	false	MEDIUM
camel.sink.endpoint.writeTimeoutMillis	Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead	null	false	LOW
camel.sink.endpoint.action	The default action. Can be overridden by CamelConsulAction	null	false	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	false	MEDIUM
camel.sink.endpoint.valueAsString	Default to transform values retrieved from Consul i.e. on KV endpoint to string.	false	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	false	MEDIUM
camel.sink.endpoint.consistencyMode	The consistencyMode used for queries, default ConsistencyMode.DEFAULT One of: [DEFAULT] [STALE] [CONSISTENT]	"DEFAULT"	false	MEDIUM
camel.sink.endpoint.datacenter	The data center	null	false	MEDIUM
camel.sink.endpoint.nearNode	The near node to use for queries.	null	false	MEDIUM
camel.sink.endpoint.nodeMeta	The note meta-data to use for queries.	null	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	false	MEDIUM
camel.sink.endpoint.aclToken	Sets the ACL token to be used with Consul	null	false	MEDIUM
camel.sink.endpoint.password	Sets the password to be used for basic authentication	null	false	MEDIUM
camel.sink.endpoint.sslContextParameters	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.	null	false	MEDIUM
camel.sink.endpoint.userName	Sets the username to be used for basic authentication	null	false	MEDIUM
camel.component.consul.connectTimeout	Connect timeout for OkHttpClient	null	false	MEDIUM
camel.component.consul.connectTimeoutMillis	Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead	null	false	LOW
camel.component.consul.consulClient	Reference to a com.orbitz.consul.Consul in the registry.	null	false	MEDIUM
camel.component.consul.key	The default key. Can be overridden by CamelConsulKey	null	false	MEDIUM
camel.component.consul.pingInstance	Configure if the AgentClient should attempt a ping before returning the Consul instance	true	false	MEDIUM
camel.component.consul.readTimeout	Read timeout for OkHttpClient	null	false	MEDIUM
camel.component.consul.readTimeoutMillis	Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead	null	false	LOW
camel.component.consul.tags	Set tags. You can separate multiple tags by comma.	null	false	MEDIUM
camel.component.consul.url	The Consul agent URL	null	false	MEDIUM
camel.component.consul.writeTimeout	Write timeout for OkHttpClient	null	false	MEDIUM
camel.component.consul.writeTimeoutMillis	Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead	null	false	LOW
camel.component.consul.action	The default action. Can be overridden by CamelConsulAction	null	false	MEDIUM
camel.component.consul.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	false	MEDIUM
camel.component.consul.valueAsString	Default to transform values retrieved from Consul i.e. on KV endpoint to string.	false	false	MEDIUM
camel.component.consul.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.consul.configuration	Consul configuration	null	false	MEDIUM
camel.component.consul.consistencyMode	The consistencyMode used for queries, default ConsistencyMode.DEFAULT One of: [DEFAULT] [STALE] [CONSISTENT]	"DEFAULT"	false	MEDIUM
camel.component.consul.datacenter	The data center	null	false	MEDIUM
camel.component.consul.nearNode	The near node to use for queries.	null	false	MEDIUM
camel.component.consul.nodeMeta	The note meta-data to use for queries.	null	false	MEDIUM
camel.component.consul.aclToken	Sets the ACL token to be used with Consul	null	false	MEDIUM
camel.component.consul.password	Sets the password to be used for basic authentication	null	false	MEDIUM
camel.component.consul.sslContextParameters	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.	null	false	MEDIUM
camel.component.consul.useGlobalSslContext Parameters	Enable usage of global SSL context parameters.	false	false	MEDIUM
camel.component.consul.userName	Sets the username to be used for basic authentication	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.apiEndpoint

The API endpoint

null

true

HIGH

camel.sink.endpoint.connectTimeout

Connect timeout for OkHttpClient

null

false

MEDIUM

camel.sink.endpoint.connectTimeoutMillis

Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead

null

false

LOW

camel.sink.endpoint.consulClient

Reference to a com.orbitz.consul.Consul in the registry.

null

false

MEDIUM

camel.sink.endpoint.key

The default key. Can be overridden by CamelConsulKey

null

false

MEDIUM

camel.sink.endpoint.pingInstance

Configure if the AgentClient should attempt a ping before returning the Consul instance

true

false

MEDIUM

camel.sink.endpoint.readTimeout

Read timeout for OkHttpClient

null

false

MEDIUM

camel.sink.endpoint.readTimeoutMillis

Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead

null

false

LOW

camel.sink.endpoint.tags

Set tags. You can separate multiple tags by comma.

null

false

MEDIUM

camel.sink.endpoint.url

The Consul agent URL

null

false

MEDIUM

camel.sink.endpoint.writeTimeout

Write timeout for OkHttpClient

null

false

MEDIUM

camel.sink.endpoint.writeTimeoutMillis

Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead

null

false

LOW

camel.sink.endpoint.action

The default action. Can be overridden by CamelConsulAction

null

false

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.valueAsString

Default to transform values retrieved from Consul i.e. on KV endpoint to string.

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.consistencyMode

The consistencyMode used for queries, default ConsistencyMode.DEFAULT One of: [DEFAULT] [STALE] [CONSISTENT]

"DEFAULT"

false

MEDIUM

camel.sink.endpoint.datacenter

The data center

null

false

MEDIUM

camel.sink.endpoint.nearNode

The near node to use for queries.

null

false

MEDIUM

camel.sink.endpoint.nodeMeta

The note meta-data to use for queries.

null

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.sink.endpoint.aclToken

Sets the ACL token to be used with Consul

null

false

MEDIUM

camel.sink.endpoint.password

Sets the password to be used for basic authentication

null

false

MEDIUM

camel.sink.endpoint.sslContextParameters

SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.

null

false

MEDIUM

camel.sink.endpoint.userName

Sets the username to be used for basic authentication

null

false

MEDIUM

camel.component.consul.connectTimeout

Connect timeout for OkHttpClient

null

false

MEDIUM

camel.component.consul.connectTimeoutMillis

Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead

null

false

LOW

camel.component.consul.consulClient

Reference to a com.orbitz.consul.Consul in the registry.

null

false

MEDIUM

camel.component.consul.key

The default key. Can be overridden by CamelConsulKey

null

false

MEDIUM

camel.component.consul.pingInstance

Configure if the AgentClient should attempt a ping before returning the Consul instance

true

false

MEDIUM

camel.component.consul.readTimeout

Read timeout for OkHttpClient

null

false

MEDIUM

camel.component.consul.readTimeoutMillis

Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead

null

false

LOW

camel.component.consul.tags

Set tags. You can separate multiple tags by comma.

null

false

MEDIUM

camel.component.consul.url

The Consul agent URL

null

false

MEDIUM

camel.component.consul.writeTimeout

Write timeout for OkHttpClient

null

false

MEDIUM

camel.component.consul.writeTimeoutMillis

Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead

null

false

LOW

camel.component.consul.action

The default action. Can be overridden by CamelConsulAction

null

false

MEDIUM

camel.component.consul.lazyStartProducer

false

MEDIUM

camel.component.consul.valueAsString

Default to transform values retrieved from Consul i.e. on KV endpoint to string.

false

MEDIUM

camel.component.consul.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

LOW

camel.component.consul.configuration

Consul configuration

null

false

MEDIUM

camel.component.consul.consistencyMode

The consistencyMode used for queries, default ConsistencyMode.DEFAULT One of: [DEFAULT] [STALE] [CONSISTENT]

"DEFAULT"

false

MEDIUM

camel.component.consul.datacenter

The data center

null

false

MEDIUM

camel.component.consul.nearNode

The near node to use for queries.

null

false

MEDIUM

camel.component.consul.nodeMeta

The note meta-data to use for queries.

null

false

MEDIUM

camel.component.consul.aclToken

Sets the ACL token to be used with Consul

null

false

MEDIUM

camel.component.consul.password

Sets the password to be used for basic authentication

null

false

MEDIUM

camel.component.consul.sslContextParameters

SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.

null

false

MEDIUM

camel.component.consul.useGlobalSslContext Parameters

Enable usage of global SSL context parameters.

false

MEDIUM

camel.component.consul.userName

Sets the username to be used for basic authentication

null

false

MEDIUM

The camel-consul sink connector has no converters out of the box.

The camel-consul sink connector has no transforms out of the box.

The camel-consul sink connector has no aggregation strategies out of the box.