Skip to content

Commit

Permalink
Add note about inadvertent breakage for HLRC in 7.16 regarding indice…
Browse files Browse the repository at this point in the history
…s options (elastic#89469)

This adds a note about an unintended break in behavior for the HLRC with
regard to the indices options that are sent by default with requests.

Relates to elastic#77864
  • Loading branch information
dakrone committed Aug 23, 2022
1 parent 7878577 commit 43b0c9c
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/reference/migration/migrate_7_16.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,30 @@ work with {es} 7.17.
A more permanent solution is to
{java-api-client}/migrate-hlrc.html[migrate from the (HLRC)] entirely.
====

[[breaking_716_indices_options]]
.The `ignore_throttled` parameter is deprecated and changes indices options sent to Elasticsearch
[%collapsible]
====
*Details* +
In https://github.com/elastic/elasticsearch/pull/77864[#77864] the High Level Rest Client was changed to only send indices options if the request differed from the default request options. However, in some cases the default options for the HLRC request object inadvertently differ from the effective options of the {es} APIs, meaning that it is possible for the API response to differ.
*Impact* +
If you use the HLRC and have a differing response due to indices options, you can update the options using the `indicesOptions(...)` method, as shown below:
[source,java]
----
// Previously:
highLevelClient.indices().exists(request, RequestOptions.DEFAULT);
// With indices options (change boolean options as needed):
final var requestWithOptions = request.indicesOptions(IndicesOptions.fromOptions(false, false, true, false));
highLevelClient.indices().exists(requestWithOptions, RequestOptions.DEFAULT);
----
A more permanent solution is to
{java-api-client}/migrate-hlrc.html[migrate from the (HLRC)] entirely.
====
// end::notable-breaking-changes[]

[discrete]
Expand Down

0 comments on commit 43b0c9c

Please sign in to comment.