Elasticsearch

Send requests to ElasticSearch via Java Client API.

What’s inside

Elasticsearch component, URI syntax: elasticsearch:clusterName

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-elasticsearch-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 18 options, which are listed below.

Name	Description	Default	Type
camel.component.elasticsearch.autowired-enabled	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
camel.component.elasticsearch.certificate-path	The path of the self-signed certificate to use to access to Elasticsearch.		String
camel.component.elasticsearch.client	To use an existing configured Elasticsearch client, instead of creating a client per endpoint. This allows customizing the client with specific settings. The option is a org.elasticsearch.client.RestClient type.		RestClient
camel.component.elasticsearch.connection-timeout	The time in ms to wait before connection will time out.	30000	Integer
camel.component.elasticsearch.enable-document-only-mode	Indicates whether the body of the message contains only documents. By default, it is set to false to be able to do the same requests as what the Document API supports (see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html for more details). To ease the migration of routes based on the legacy component camel-elasticsearch-rest, you should consider enabling the mode, especially if your routes do update operations.	false	Boolean
camel.component.elasticsearch.enable-s-s-l	Enable SSL	false	Boolean
camel.component.elasticsearch.enable-sniffer	Enable automatically discover nodes from a running Elasticsearch cluster. If this option is used in conjunction with Spring Boot, then it’s managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot).	false	Boolean
camel.component.elasticsearch.enabled	Whether to enable auto configuration of the elasticsearch component. This is enabled by default.		Boolean
camel.component.elasticsearch.host-addresses	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.		String
camel.component.elasticsearch.lazy-start-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
camel.component.elasticsearch.max-retry-timeout	The time in ms before retry	30000	Integer
camel.component.elasticsearch.password	Password for authenticating		String
camel.component.elasticsearch.sniff-after-failure-delay	The delay of a sniff execution scheduled after a failure (in milliseconds)	60000	Integer
camel.component.elasticsearch.sniffer-interval	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	Integer
camel.component.elasticsearch.socket-timeout	The timeout in ms to wait before the socket will time out.	30000	Integer
camel.component.elasticsearch.ssl-context-parameters	To configure security using SSLContextParameters. When configured, this takes precedence over the certificatePath option. The option is a org.apache.camel.support.jsse.SSLContextParameters type.		SSLContextParameters
camel.component.elasticsearch.use-global-ssl-context-parameters	Enable usage of global SSL context parameters.	false	Boolean
camel.component.elasticsearch.user	Basic authenticate user		String

Name

Description

Default

Type

camel.component.elasticsearch.autowired-enabled

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

camel.component.elasticsearch.certificate-path

The path of the self-signed certificate to use to access to Elasticsearch.

String

camel.component.elasticsearch.client

To use an existing configured Elasticsearch client, instead of creating a client per endpoint. This allows customizing the client with specific settings. The option is a org.elasticsearch.client.RestClient type.

RestClient

camel.component.elasticsearch.connection-timeout

The time in ms to wait before connection will time out.

30000

Integer

camel.component.elasticsearch.enable-document-only-mode

Indicates whether the body of the message contains only documents. By default, it is set to false to be able to do the same requests as what the Document API supports (see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html for more details). To ease the migration of routes based on the legacy component camel-elasticsearch-rest, you should consider enabling the mode, especially if your routes do update operations.

false

Boolean

camel.component.elasticsearch.enable-s-s-l

Enable SSL

false

Boolean

camel.component.elasticsearch.enable-sniffer

Enable automatically discover nodes from a running Elasticsearch cluster. If this option is used in conjunction with Spring Boot, then it’s managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot).

false

Boolean

camel.component.elasticsearch.enabled

Whether to enable auto configuration of the elasticsearch component. This is enabled by default.

Boolean

camel.component.elasticsearch.host-addresses

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.

String

camel.component.elasticsearch.lazy-start-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

camel.component.elasticsearch.max-retry-timeout

The time in ms before retry

30000

Integer

camel.component.elasticsearch.password

Password for authenticating

String

camel.component.elasticsearch.sniff-after-failure-delay

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

60000

Integer

camel.component.elasticsearch.sniffer-interval

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

Integer

camel.component.elasticsearch.socket-timeout

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

30000

Integer

camel.component.elasticsearch.ssl-context-parameters

To configure security using SSLContextParameters. When configured, this takes precedence over the certificatePath option. The option is a org.apache.camel.support.jsse.SSLContextParameters type.

SSLContextParameters

camel.component.elasticsearch.use-global-ssl-context-parameters

Enable usage of global SSL context parameters.

false

Boolean

camel.component.elasticsearch.user

Basic authenticate user

String