camel-elasticsearch-rest-kafka-connector sink configuration

When using camel-elasticsearch-rest-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-elasticsearch-rest-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.elasticsearchrest.CamelElasticsearchrestSinkConnector

The camel-elasticsearch-rest sink connector supports 33 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.clusterName	Name of the cluster	null	true	HIGH
camel.sink.endpoint.connectionTimeout	The time in ms to wait before connection will timeout.	30000	false	MEDIUM
camel.sink.endpoint.disconnect	Disconnect after it finish calling the producer	false	false	MEDIUM
camel.sink.endpoint.enableSniffer	Enable automatically discover nodes from a running Elasticsearch cluster	false	false	MEDIUM
camel.sink.endpoint.enableSSL	Enable SSL	false	false	MEDIUM
camel.sink.endpoint.from	Starting index of the response.	null	false	MEDIUM
camel.sink.endpoint.hostAddresses	Comma separated list with ip:port formatted remote transport addresses to use.	null	true	HIGH
camel.sink.endpoint.indexName	The name of the index to act against	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.maxRetryTimeout	The time in ms before retry	30000	false	MEDIUM
camel.sink.endpoint.operation	What operation to perform One of: [Index] [Update] [Bulk] [BulkIndex] [GetById] [MultiGet] [MultiSearch] [Delete] [DeleteIndex] [Search] [Exists] [Ping]	null	false	MEDIUM
camel.sink.endpoint.scrollKeepAliveMs	Time in ms during which elasticsearch will keep search context alive	60000	false	MEDIUM
camel.sink.endpoint.size	Size of the response.	null	false	MEDIUM
camel.sink.endpoint.sniffAfterFailureDelay	The delay of a sniff execution scheduled after a failure (in milliseconds)	60000	false	MEDIUM
camel.sink.endpoint.snifferInterval	The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions	300000	false	MEDIUM
camel.sink.endpoint.socketTimeout	The timeout in ms to wait before the socket will timeout.	30000	false	MEDIUM
camel.sink.endpoint.useScroll	Enable scroll usage	false	false	MEDIUM
camel.sink.endpoint.waitForActiveShards	Index creation waits for the write consistency number of shards to be available	1	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.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.component.elasticsearch-rest.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	false	MEDIUM
camel.component.elasticsearch-rest.basicProperty Binding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.elasticsearch-rest.client	To use an existing configured Elasticsearch client, instead of creating a client per endpoint. This allow to customize the client with specific settings.	null	false	MEDIUM
camel.component.elasticsearch-rest.connection Timeout	The time in ms to wait before connection will timeout.	30000	false	MEDIUM
camel.component.elasticsearch-rest.enableSniffer	Enable automatically discover nodes from a running Elasticsearch cluster	"false"	false	MEDIUM
camel.component.elasticsearch-rest.hostAddresses	Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for hostAddresses to be considered instead.	null	false	MEDIUM
camel.component.elasticsearch-rest.maxRetryTimeout	The time in ms before retry	30000	false	MEDIUM
camel.component.elasticsearch-rest.sniffAfter FailureDelay	The delay of a sniff execution scheduled after a failure (in milliseconds)	60000	false	MEDIUM
camel.component.elasticsearch-rest.snifferInterval	The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions	300000	false	MEDIUM
camel.component.elasticsearch-rest.socketTimeout	The timeout in ms to wait before the socket will timeout.	30000	false	MEDIUM
camel.component.elasticsearch-rest.enableSSL	Enable SSL	"false"	false	MEDIUM
camel.component.elasticsearch-rest.password	Password for authenticate	null	false	MEDIUM
camel.component.elasticsearch-rest.user	Basic authenticate user	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.clusterName

Name of the cluster

null

true

HIGH

camel.sink.endpoint.connectionTimeout

The time in ms to wait before connection will timeout.

30000

false

MEDIUM

camel.sink.endpoint.disconnect

Disconnect after it finish calling the producer

false

MEDIUM

camel.sink.endpoint.enableSniffer

Enable automatically discover nodes from a running Elasticsearch cluster

false

MEDIUM

camel.sink.endpoint.enableSSL

Enable SSL

false

MEDIUM

camel.sink.endpoint.from

Starting index of the response.

null

false

MEDIUM

camel.sink.endpoint.hostAddresses

Comma separated list with ip:port formatted remote transport addresses to use.

null

true

HIGH

camel.sink.endpoint.indexName

The name of the index to act against

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

The time in ms before retry

30000

false

MEDIUM

camel.sink.endpoint.operation

What operation to perform One of: [Index] [Update] [Bulk] [BulkIndex] [GetById] [MultiGet] [MultiSearch] [Delete] [DeleteIndex] [Search] [Exists] [Ping]

null

false

MEDIUM

camel.sink.endpoint.scrollKeepAliveMs

Time in ms during which elasticsearch will keep search context alive

60000

false

MEDIUM

camel.sink.endpoint.size

Size of the response.

null

false

MEDIUM

camel.sink.endpoint.sniffAfterFailureDelay

The delay of a sniff execution scheduled after a failure (in milliseconds)

60000

false

MEDIUM

camel.sink.endpoint.snifferInterval

The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions

300000

false

MEDIUM

camel.sink.endpoint.socketTimeout

The timeout in ms to wait before the socket will timeout.

30000

false

MEDIUM

camel.sink.endpoint.useScroll

Enable scroll usage

false

MEDIUM

camel.sink.endpoint.waitForActiveShards

Index creation waits for the write consistency number of shards to be available

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.elasticsearch-rest.lazyStart Producer

false

MEDIUM

camel.component.elasticsearch-rest.basicProperty Binding

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

false

LOW

camel.component.elasticsearch-rest.client

To use an existing configured Elasticsearch client, instead of creating a client per endpoint. This allow to customize the client with specific settings.

null

false

MEDIUM

camel.component.elasticsearch-rest.connection Timeout

The time in ms to wait before connection will timeout.

30000

false

MEDIUM

camel.component.elasticsearch-rest.enableSniffer

Enable automatically discover nodes from a running Elasticsearch cluster

"false"

false

MEDIUM

camel.component.elasticsearch-rest.hostAddresses

Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for hostAddresses to be considered instead.

null

false

MEDIUM

camel.component.elasticsearch-rest.maxRetryTimeout

The time in ms before retry

30000

false

MEDIUM

camel.component.elasticsearch-rest.sniffAfter FailureDelay

The delay of a sniff execution scheduled after a failure (in milliseconds)

60000

false

MEDIUM

camel.component.elasticsearch-rest.snifferInterval

The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions

300000

false

MEDIUM

camel.component.elasticsearch-rest.socketTimeout

The timeout in ms to wait before the socket will timeout.

30000

false

MEDIUM

camel.component.elasticsearch-rest.enableSSL

Enable SSL

"false"

false

MEDIUM

camel.component.elasticsearch-rest.password

Password for authenticate

null

false

MEDIUM

camel.component.elasticsearch-rest.user

Basic authenticate user

null

false

MEDIUM

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

The camel-elasticsearch-rest sink connector supports 0 transforms out of the box, which are listed below.

org.apache.camel.kafkaconnector.elasticsearchrest.transformers.ConnectRecordValueToMapTransforms

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