camel-elasticsearch-rest-kafka-connector sink configuration

Connector Description: Send requests to with an ElasticSearch via REST API.

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 31 options, which are listed below.

Name Description Default Priority

camel.sink.path.clusterName

Required Name of the cluster.

HIGH

camel.sink.endpoint.connectionTimeout

The time in ms to wait before connection will timeout.

30000

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.

MEDIUM

camel.sink.endpoint.hostAddresses

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

HIGH

camel.sink.endpoint.indexName

The name of the index to act against.

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

MEDIUM

camel.sink.endpoint.operation

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

Enum values:

  • Index

  • Update

  • Bulk

  • BulkIndex

  • GetById

  • MultiGet

  • MultiSearch

  • Delete

  • DeleteIndex

  • Search

  • Exists

  • Ping

MEDIUM

camel.sink.endpoint.scrollKeepAliveMs

Time in ms during which elasticsearch will keep search context alive.

60000

MEDIUM

camel.sink.endpoint.size

Size of the response.

MEDIUM

camel.sink.endpoint.sniffAfterFailureDelay

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

60000

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

MEDIUM

camel.sink.endpoint.socketTimeout

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

30000

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.

1

MEDIUM

camel.component.elasticsearch-rest.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.elasticsearch-rest.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

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.

MEDIUM

camel.component.elasticsearch-rest.connectionTimeout

The time in ms to wait before connection will timeout.

30000

MEDIUM

camel.component.elasticsearch-rest.enableSniffer

Enable automatically discover nodes from a running Elasticsearch cluster.

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

MEDIUM

camel.component.elasticsearch-rest.maxRetryTimeout

The time in ms before retry.

30000

MEDIUM

camel.component.elasticsearch-rest.sniffAfterFailureDelay

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

60000

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

MEDIUM

camel.component.elasticsearch-rest.socketTimeout

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

30000

MEDIUM

camel.component.elasticsearch-rest.enableSSL

Enable SSL.

"false"

MEDIUM

camel.component.elasticsearch-rest.password

Password for authenticate.

MEDIUM

camel.component.elasticsearch-rest.user

Basic authenticate user.

MEDIUM

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

The camel-elasticsearch-rest sink connector supports 1 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.

Back to top