-
Notifications
You must be signed in to change notification settings - Fork 242
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for Exception caused by rest-client version mismatch (#647)
- Loading branch information
Showing
2 changed files
with
44 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
docs/troubleshooting/no-such-method-request-options.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
|
||
[[no-such-method-request-options]] | ||
=== `NoSuchMethodError RequestOptions$Builder.removeHeader` when creating a client | ||
|
||
In certain contexts you may encounter an error when creating the `ElasticsearchClient` saying that the method `RequestOptions$Builder.removeHeader` does not exist: | ||
|
||
["source","java"] | ||
-------------------------------------------------- | ||
java.lang.NoSuchMethodError: 'org.elasticsearch.client.RequestOptions$Builder org.elasticsearch.client.RequestOptions$Builder.removeHeader(java.lang.String)' | ||
-------------------------------------------------- | ||
|
||
This method was introduced in `elasticsearch-rest-client` version 7.16.0. The error happens because your project is using an older version of this dependency. | ||
|
||
This happens in particular when the project is using the https://docs.spring.io/spring-boot/docs/current/maven-plugin/reference/htmlsingle/[Spring Boot Maven Plugin], as this plugin https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-dependencies/build.gradle[defines versions for commonly used libraries], including `elasticsearch-rest-client`. Depending on the version of Spring Boot used in the project, that version may be outdated. | ||
|
||
To solve this issue, you have to add the `elasticsearch-rest-client` dependency explicitly in your project, with the same version as `elasticsearch-java` (see also <<installation>>). | ||
|
||
Using Gradle: | ||
|
||
["source","groovy",subs="attributes+"] | ||
-------------------------------------------------- | ||
implementation 'org.elasticsearch.client:elasticsearch-rest-client:{version}' | ||
-------------------------------------------------- | ||
|
||
|
||
Using Maven: | ||
|
||
["source","xml",subs="attributes+"] | ||
-------------------------------------------------- | ||
<dependency> | ||
<groupId>org.elasticsearch.client</groupId> | ||
<artifactId>elasticsearch-rest-client</artifactId> | ||
<version>{version}</version> | ||
</dependency> | ||
-------------------------------------------------- | ||
|