Elasticsearch Low level Rest Client

Since Camel 4.3

Only producer is supported

The ElasticSearch component allows you to interface with ElasticSearch 8.x API or OpenSearch using the ElasticSearch Java Low level Rest Client.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-elasticsearch-rest-client</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

elasticsearch-rest-client://clusterName[?options]

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.

For example, a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

You can configure components using:

  • the Component DSL.

  • in a configuration file (application.properties, *.yaml files, etc).

  • directly in the Java code.

Configuring Endpoint Options

You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders.

Property placeholders provide a few benefits:

  • They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.

  • They allow externalizing the configuration from the code.

  • They help the code to become more flexible and reusable.

The following two sections list all the options, firstly for the component followed by the endpoint.

Component Options

The Elasticsearch Low level Rest Client component supports 2 options, which are listed below.

Name Description Default Type

lazyStartProducer (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

boolean

autowiredEnabled (advanced)

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

boolean

Endpoint Options

The Elasticsearch Low level Rest Client endpoint is configured using URI syntax:

elasticsearch-rest-client:clusterName

With the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

clusterName (producer)

Required Cluster Name.

String

Query Parameters (13 parameters)

Name Description Default Type

connectionTimeout (producer)

Connection timeout.

30000

int

hostAddressesList (producer)

List of host Addresses, multiple hosts can be separated by comma.

String

indexName (producer)

Index Name.

String

operation (producer)

Required Operation.

Enum values:

  • INDEX_OR_UPDATE

  • GET_BY_ID

  • DELETE

  • CREATE_INDEX

  • DELETE_INDEX

  • SEARCH

ElasticsearchRestClientOperation

socketTimeout (producer)

Socket timeout.

30000

int

lazyStartProducer (producer (advanced))

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

boolean

enableSniffer (advanced)

Enabling Sniffer.

false

boolean

restClient (advanced)

Autowired Rest Client of type org.elasticsearch.client.RestClient. This is only for advanced usage.

RestClient

sniffAfterFailureDelay (advanced)

Sniffer after failure delay (in millis).

60000

int

snifferInterval (advanced)

Sniffer interval (in millis).

60000

int

certificatePath (security)

Certificate Path.

String

password (security)

Password.

String

user (security)

Username.

String

Async Producer

This component implements the async producer.

This allows Camel route to produce events asynchronously without blocking any threads.

Back to top