Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs for Exception caused by rest-client version mismatch #647

Merged
merged 2 commits into from
Aug 16, 2023
Merged

Add docs for Exception caused by rest-client version mismatch #647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3112642
Add docs for Exception caused by rest-client version mismatch
swallez Aug 16, 2023
e21e148
Fix code format
swallez Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/troubleshooting/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@
// * <<debugging>>
// * <<deprecation-warnings>>

.Exceptions
[discrete]
=== Exceptions

* <<missing-required-property>>
* <<serialize-without-typed-keys>>
* <<no-such-method-request-options>>

[discrete]
=== Miscellaneous

* <<serialize-without-typed-keys>>

// [[debugging]]
// === Debugging
Expand All @@ -17,4 +22,5 @@
// === Elasticsearch deprecation warnings

include::missing-required-property.asciidoc[]
include::no-such-method-request-options.asciidoc[]
include::serialize-without-typed-keys.asciidoc[]
36 changes: 36 additions & 0 deletions docs/troubleshooting/no-such-method-request-options.asciidoc
View file
Open in desktop
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>
--------------------------------------------------

Loading