generated from camel.apache.org/component
2
Home
gitea_admin edited this page 2026-03-11 14:37:42 +00:00
Table of Contents
Elasticsearch
Send requests to ElasticSearch via Java Client API.
Metadata
| Property | Value |
|---|---|
| Scheme | elasticsearch |
| Support Level | Stable |
| Labels | search,monitoring |
| Version | 4.10.2 |
Maven Dependency
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-elasticsearch</artifactId>
<version>4.10.2</version>
</dependency>
Endpoint Properties
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
clusterName |
string | ✓ | Name of the cluster | |
connectionTimeout |
integer | 30000 |
The time in ms to wait before connection will time out. | |
disconnect |
boolean | false |
Disconnect after it finish calling the producer | |
enableDocumentOnlyMode |
boolean | false |
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. | |
from |
integer | Starting index of the response. | ||
hostAddresses |
string | Comma separated list with ip:port formatted remote transport addresses to use. | ||
indexName |
string | The name of the index to act against | ||
maxRetryTimeout |
integer | 30000 |
The time in ms before retry | |
operation |
object | What operation to perform | ||
scrollKeepAliveMs |
integer | 60000 |
Time in ms during which elasticsearch will keep search context alive | |
size |
integer | Size of the response. | ||
socketTimeout |
integer | 30000 |
The timeout in ms to wait before the socket will time out. | |
useScroll |
boolean | false |
Enable scroll usage | |
waitForActiveShards |
integer | 1 |
Index creation waits for the write consistency number of shards to be available | |
lazyStartProducer |
boolean | false |
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. | |
documentClass |
string | ObjectNode |
The class to use when deserializing the documents. | |
enableSniffer |
boolean | false |
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). | |
sniffAfterFailureDelay |
integer | 60000 |
The delay of a sniff execution scheduled after a failure (in milliseconds) | |
snifferInterval |
integer | 300000 |
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 | |
certificatePath |
string | The certificate that can be used to access the ES Cluster. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. | ||
enableSSL |
boolean | false |
Enable SSL |