Skip to content

Commit 704752b

Browse files
authored
Deprecate ignore_throttled parameter (#77864)
* Deprecate ignore_throttled parameter Backporting #77479 to 7.x branch. Frozen indices are deprecated, which will make ignore_throttled obsolete. Some changes to HLRC HLRC and related tests were required in order to deprecate ignore_throttled parameter: * Change HLRC request classes to set indices options initial value to null. This avoids sending the ignore_throttled parameter (and other indices options parameters) and therefore avoids the depracation warning header in the response. All these request classes had the indices options set to what is the defaukt in the corresponding action request class. So sending these indices options params was a noop, which is the same as not sending indices options parameters, which is what this change does. * For transport action request classes that are reused in the HLRC as request class, change the corresponding hlrc request converter to only send indices options params if the indices options are different than what the default is. * For tests that use a non default indices options, allow 'ignore_throttled is deprecated' warning. Other changes: * A number of tests have been changed to allowed warning header for deprecated ignore_throttled parameter. * Some rest v7 compat yaml tests are temporary muted, but will be unmuted once this change has been backported. Relates to #70192 * adjust to 7.x reality * adjust to 7.x reality (2) * adjust 7.x request converters * more 7.x adjustments
1 parent 303a7b9 commit 704752b

File tree

50 files changed

+372
-157
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+372
-157
lines changed

client/rest-high-level/src/main/java/org/elasticsearch/client/AsyncSearchRequestConverters.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
import org.apache.http.client.methods.HttpDelete;
1212
import org.apache.http.client.methods.HttpGet;
1313
import org.apache.http.client.methods.HttpPost;
14+
import org.elasticsearch.action.search.SearchRequest;
1415
import org.elasticsearch.client.RequestConverters.Params;
1516
import org.elasticsearch.client.asyncsearch.DeleteAsyncSearchRequest;
1617
import org.elasticsearch.client.asyncsearch.GetAsyncSearchRequest;
@@ -53,7 +54,9 @@ static void addSearchRequestParams(Params params, SubmitAsyncSearchRequest reque
5354
params.putParam(RestSearchAction.TYPED_KEYS_PARAM, "true");
5455
params.withRouting(request.getRouting());
5556
params.withPreference(request.getPreference());
56-
params.withIndicesOptions(request.getIndicesOptions());
57+
if (SearchRequest.DEFAULT_INDICES_OPTIONS.equals(request.getIndicesOptions()) == false) {
58+
params.withIndicesOptions(request.getIndicesOptions());
59+
}
5760
params.withSearchType(request.getSearchType().name().toLowerCase(Locale.ROOT));
5861
params.withMaxConcurrentShardRequests(request.getMaxConcurrentShardRequests());
5962
if (request.getRequestCache() != null) {

client/rest-high-level/src/main/java/org/elasticsearch/client/IndicesRequestConverters.java

+63-20
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@
2727
import org.elasticsearch.action.admin.indices.shrink.ResizeType;
2828
import org.elasticsearch.action.admin.indices.template.delete.DeleteIndexTemplateRequest;
2929
import org.elasticsearch.action.admin.indices.validate.query.ValidateQueryRequest;
30+
import org.elasticsearch.action.support.broadcast.BroadcastRequest;
3031
import org.elasticsearch.action.support.ActiveShardCount;
32+
import org.elasticsearch.action.support.master.info.ClusterInfoRequest;
3133
import org.elasticsearch.client.indices.AnalyzeRequest;
3234
import org.elasticsearch.client.indices.CloseIndexRequest;
3335
import org.elasticsearch.client.indices.CreateDataStreamRequest;
@@ -104,7 +106,9 @@ static Request deleteIndex(DeleteIndexRequest deleteIndexRequest) {
104106
RequestConverters.Params parameters = new RequestConverters.Params();
105107
parameters.withTimeout(deleteIndexRequest.timeout());
106108
parameters.withMasterTimeout(deleteIndexRequest.masterNodeTimeout());
107-
parameters.withIndicesOptions(deleteIndexRequest.indicesOptions());
109+
if (DeleteIndexRequest.DEFAULT_INDICES_OPTIONS.equals(deleteIndexRequest.indicesOptions()) == false) {
110+
parameters.withIndicesOptions(deleteIndexRequest.indicesOptions());
111+
}
108112
request.addParameters(parameters.asMap());
109113
return request;
110114
}
@@ -117,7 +121,9 @@ static Request openIndex(OpenIndexRequest openIndexRequest) {
117121
parameters.withTimeout(openIndexRequest.timeout());
118122
parameters.withMasterTimeout(openIndexRequest.masterNodeTimeout());
119123
parameters.withWaitForActiveShards(openIndexRequest.waitForActiveShards());
120-
parameters.withIndicesOptions(openIndexRequest.indicesOptions());
124+
if (OpenIndexRequest.DEFAULT_INDICES_OPTIONS.equals(openIndexRequest.indicesOptions()) == false) {
125+
parameters.withIndicesOptions(openIndexRequest.indicesOptions());
126+
}
121127
request.addParameters(parameters.asMap());
122128
return request;
123129
}
@@ -129,7 +135,9 @@ static Request closeIndex(CloseIndexRequest closeIndexRequest) {
129135
RequestConverters.Params parameters = new RequestConverters.Params();
130136
parameters.withTimeout(closeIndexRequest.timeout());
131137
parameters.withMasterTimeout(closeIndexRequest.masterNodeTimeout());
132-
parameters.withIndicesOptions(closeIndexRequest.indicesOptions());
138+
if (CloseIndexRequest.DEFAULT_INDICES_OPTIONS.equals(closeIndexRequest.indicesOptions()) == false) {
139+
parameters.withIndicesOptions(closeIndexRequest.indicesOptions());
140+
}
133141

134142
final ActiveShardCount activeShardCount = closeIndexRequest.waitForActiveShards();
135143
if (activeShardCount == ActiveShardCount.DEFAULT) {
@@ -188,7 +196,9 @@ static Request putMapping(PutMappingRequest putMappingRequest) throws IOExceptio
188196
RequestConverters.Params parameters = new RequestConverters.Params();
189197
parameters.withTimeout(putMappingRequest.timeout());
190198
parameters.withMasterTimeout(putMappingRequest.masterNodeTimeout());
191-
parameters.withIndicesOptions(putMappingRequest.indicesOptions());
199+
if (PutMappingRequest.DEFAULT_INDICES_OPTIONS.equals(putMappingRequest.indicesOptions()) == false) {
200+
parameters.withIndicesOptions(putMappingRequest.indicesOptions());
201+
}
192202
request.addParameters(parameters.asMap());
193203
request.setEntity(RequestConverters.createEntity(putMappingRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
194204
return request;
@@ -239,7 +249,9 @@ static Request getMappings(org.elasticsearch.action.admin.indices.mapping.get.Ge
239249

240250
RequestConverters.Params parameters = new RequestConverters.Params();
241251
parameters.withMasterTimeout(getMappingsRequest.masterNodeTimeout());
242-
parameters.withIndicesOptions(getMappingsRequest.indicesOptions());
252+
if (ClusterInfoRequest.DEFAULT_INDICES_OPTIONS.equals(getMappingsRequest.indicesOptions()) == false) {
253+
parameters.withIndicesOptions(getMappingsRequest.indicesOptions());
254+
}
243255
parameters.withLocal(getMappingsRequest.local());
244256
parameters.putParam(INCLUDE_TYPE_NAME_PARAMETER, "true");
245257
request.addParameters(parameters.asMap());
@@ -280,7 +292,10 @@ static Request getFieldMapping(org.elasticsearch.action.admin.indices.mapping.ge
280292
Request request = new Request(HttpGet.METHOD_NAME, endpoint);
281293

282294
RequestConverters.Params parameters = new RequestConverters.Params();
283-
parameters.withIndicesOptions(getFieldMappingsRequest.indicesOptions());
295+
if (org.elasticsearch.action.admin.indices.mapping.get.GetFieldMappingsRequest.DEFAULT_INDICES_OPTIONS.equals(
296+
getFieldMappingsRequest.indicesOptions()) == false) {
297+
parameters.withIndicesOptions(getFieldMappingsRequest.indicesOptions());
298+
}
284299
parameters.withIncludeDefaults(getFieldMappingsRequest.includeDefaults());
285300
parameters.withLocal(getFieldMappingsRequest.local());
286301
parameters.putParam(INCLUDE_TYPE_NAME_PARAMETER, "true");
@@ -293,7 +308,9 @@ static Request refresh(RefreshRequest refreshRequest) {
293308
Request request = new Request(HttpPost.METHOD_NAME, RequestConverters.endpoint(indices, "_refresh"));
294309

295310
RequestConverters.Params parameters = new RequestConverters.Params();
296-
parameters.withIndicesOptions(refreshRequest.indicesOptions());
311+
if (BroadcastRequest.DEFAULT_INDICES_OPTIONS.equals(refreshRequest.indicesOptions()) == false) {
312+
parameters.withIndicesOptions(refreshRequest.indicesOptions());
313+
}
297314
request.addParameters(parameters.asMap());
298315
return request;
299316
}
@@ -303,7 +320,9 @@ static Request flush(FlushRequest flushRequest) {
303320
Request request = new Request(HttpPost.METHOD_NAME, RequestConverters.endpoint(indices, "_flush"));
304321

305322
RequestConverters.Params parameters = new RequestConverters.Params();
306-
parameters.withIndicesOptions(flushRequest.indicesOptions());
323+
if (BroadcastRequest.DEFAULT_INDICES_OPTIONS.equals(flushRequest.indicesOptions()) == false) {
324+
parameters.withIndicesOptions(flushRequest.indicesOptions());
325+
}
307326
parameters.putParam("wait_if_ongoing", Boolean.toString(flushRequest.waitIfOngoing()));
308327
parameters.putParam("force", Boolean.toString(flushRequest.force()));
309328
request.addParameters(parameters.asMap());
@@ -324,7 +343,9 @@ static Request forceMerge(ForceMergeRequest forceMergeRequest) {
324343
Request request = new Request(HttpPost.METHOD_NAME, RequestConverters.endpoint(indices, "_forcemerge"));
325344

326345
RequestConverters.Params parameters = new RequestConverters.Params();
327-
parameters.withIndicesOptions(forceMergeRequest.indicesOptions());
346+
if (BroadcastRequest.DEFAULT_INDICES_OPTIONS.equals(forceMergeRequest.indicesOptions()) == false) {
347+
parameters.withIndicesOptions(forceMergeRequest.indicesOptions());
348+
}
328349
parameters.putParam("max_num_segments", Integer.toString(forceMergeRequest.maxNumSegments()));
329350
parameters.putParam("only_expunge_deletes", Boolean.toString(forceMergeRequest.onlyExpungeDeletes()));
330351
parameters.putParam("flush", Boolean.toString(forceMergeRequest.flush()));
@@ -337,7 +358,9 @@ static Request clearCache(ClearIndicesCacheRequest clearIndicesCacheRequest) {
337358
Request request = new Request(HttpPost.METHOD_NAME, RequestConverters.endpoint(indices, "_cache/clear"));
338359

339360
RequestConverters.Params parameters = new RequestConverters.Params();
340-
parameters.withIndicesOptions(clearIndicesCacheRequest.indicesOptions());
361+
if (BroadcastRequest.DEFAULT_INDICES_OPTIONS.equals(clearIndicesCacheRequest.indicesOptions()) == false) {
362+
parameters.withIndicesOptions(clearIndicesCacheRequest.indicesOptions());
363+
}
341364
parameters.putParam("query", Boolean.toString(clearIndicesCacheRequest.queryCache()));
342365
parameters.putParam("fielddata", Boolean.toString(clearIndicesCacheRequest.fieldDataCache()));
343366
parameters.putParam("request", Boolean.toString(clearIndicesCacheRequest.requestCache()));
@@ -357,7 +380,9 @@ static Request existsAlias(GetAliasesRequest getAliasesRequest) {
357380
Request request = new Request(HttpHead.METHOD_NAME, RequestConverters.endpoint(indices, "_alias", aliases));
358381

359382
RequestConverters.Params params = new RequestConverters.Params();
360-
params.withIndicesOptions(getAliasesRequest.indicesOptions());
383+
if (GetAliasesRequest.DEFAULT_INDICES_OPTIONS.equals(getAliasesRequest.indicesOptions()) == false) {
384+
params.withIndicesOptions(getAliasesRequest.indicesOptions());
385+
}
361386
params.withLocal(getAliasesRequest.local());
362387
request.addParameters(params.asMap());
363388
return request;
@@ -477,7 +502,9 @@ static Request getSettings(GetSettingsRequest getSettingsRequest) {
477502
Request request = new Request(HttpGet.METHOD_NAME, endpoint);
478503

479504
RequestConverters.Params params = new RequestConverters.Params();
480-
params.withIndicesOptions(getSettingsRequest.indicesOptions());
505+
if (GetSettingsRequest.DEFAULT_INDICES_OPTIONS.equals(getSettingsRequest.indicesOptions()) == false) {
506+
params.withIndicesOptions(getSettingsRequest.indicesOptions());
507+
}
481508
params.withLocal(getSettingsRequest.local());
482509
params.withIncludeDefaults(getSettingsRequest.includeDefaults());
483510
params.withMasterTimeout(getSettingsRequest.masterNodeTimeout());
@@ -497,7 +524,9 @@ static Request getIndex(org.elasticsearch.action.admin.indices.get.GetIndexReque
497524
Request request = new Request(HttpGet.METHOD_NAME, endpoint);
498525

499526
RequestConverters.Params params = new RequestConverters.Params();
500-
params.withIndicesOptions(getIndexRequest.indicesOptions());
527+
if (ClusterInfoRequest.DEFAULT_INDICES_OPTIONS.equals(getIndexRequest.indicesOptions()) == false) {
528+
params.withIndicesOptions(getIndexRequest.indicesOptions());
529+
}
501530
params.withLocal(getIndexRequest.local());
502531
params.withIncludeDefaults(getIndexRequest.includeDefaults());
503532
params.withHuman(getIndexRequest.humanReadable());
@@ -514,7 +543,9 @@ static Request getIndex(GetIndexRequest getIndexRequest) {
514543
Request request = new Request(HttpGet.METHOD_NAME, endpoint);
515544

516545
RequestConverters.Params params = new RequestConverters.Params();
517-
params.withIndicesOptions(getIndexRequest.indicesOptions());
546+
if (GetIndexRequest.DEFAULT_INDICES_OPTIONS.equals(getIndexRequest.indicesOptions()) == false) {
547+
params.withIndicesOptions(getIndexRequest.indicesOptions());
548+
}
518549
params.withLocal(getIndexRequest.local());
519550
params.withIncludeDefaults(getIndexRequest.includeDefaults());
520551
params.withHuman(getIndexRequest.humanReadable());
@@ -539,7 +570,9 @@ static Request indicesExist(org.elasticsearch.action.admin.indices.get.GetIndexR
539570
RequestConverters.Params params = new RequestConverters.Params();
540571
params.withLocal(getIndexRequest.local());
541572
params.withHuman(getIndexRequest.humanReadable());
542-
params.withIndicesOptions(getIndexRequest.indicesOptions());
573+
if (ClusterInfoRequest.DEFAULT_INDICES_OPTIONS.equals(getIndexRequest.indicesOptions()) == false) {
574+
params.withIndicesOptions(getIndexRequest.indicesOptions());
575+
}
543576
params.withIncludeDefaults(getIndexRequest.includeDefaults());
544577
params.putParam(INCLUDE_TYPE_NAME_PARAMETER, "true");
545578
request.addParameters(params.asMap());
@@ -557,7 +590,9 @@ static Request indicesExist(GetIndexRequest getIndexRequest) {
557590
RequestConverters.Params params = new RequestConverters.Params();
558591
params.withLocal(getIndexRequest.local());
559592
params.withHuman(getIndexRequest.humanReadable());
560-
params.withIndicesOptions(getIndexRequest.indicesOptions());
593+
if (GetIndexRequest.DEFAULT_INDICES_OPTIONS.equals(getIndexRequest.indicesOptions()) == false) {
594+
params.withIndicesOptions(getIndexRequest.indicesOptions());
595+
}
561596
params.withIncludeDefaults(getIndexRequest.includeDefaults());
562597
request.addParameters(params.asMap());
563598
return request;
@@ -570,7 +605,9 @@ static Request indexPutSettings(UpdateSettingsRequest updateSettingsRequest) thr
570605
RequestConverters.Params parameters = new RequestConverters.Params();
571606
parameters.withTimeout(updateSettingsRequest.timeout());
572607
parameters.withMasterTimeout(updateSettingsRequest.masterNodeTimeout());
573-
parameters.withIndicesOptions(updateSettingsRequest.indicesOptions());
608+
if (UpdateSettingsRequest.DEFAULT_INDICES_OPTIONS.equals(updateSettingsRequest.indicesOptions()) == false) {
609+
parameters.withIndicesOptions(updateSettingsRequest.indicesOptions());
610+
}
574611
parameters.withPreserveExisting(updateSettingsRequest.isPreserveExisting());
575612
request.addParameters(parameters.asMap());
576613
request.setEntity(RequestConverters.createEntity(updateSettingsRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
@@ -662,7 +699,9 @@ static Request validateQuery(ValidateQueryRequest validateQueryRequest) throws I
662699
String endpoint = RequestConverters.endpoint(indices, types, "_validate/query");
663700
Request request = new Request(HttpGet.METHOD_NAME, endpoint);
664701
RequestConverters.Params params = new RequestConverters.Params();
665-
params.withIndicesOptions(validateQueryRequest.indicesOptions());
702+
if (ValidateQueryRequest.DEFAULT_INDICES_OPTIONS.equals(validateQueryRequest.indicesOptions()) == false) {
703+
params.withIndicesOptions(validateQueryRequest.indicesOptions());
704+
}
666705
params.putParam("explain", Boolean.toString(validateQueryRequest.explain()));
667706
params.putParam("all_shards", Boolean.toString(validateQueryRequest.allShards()));
668707
params.putParam("rewrite", Boolean.toString(validateQueryRequest.rewrite()));
@@ -677,7 +716,9 @@ static Request getAlias(GetAliasesRequest getAliasesRequest) {
677716
String endpoint = RequestConverters.endpoint(indices, "_alias", aliases);
678717
Request request = new Request(HttpGet.METHOD_NAME, endpoint);
679718
RequestConverters.Params params = new RequestConverters.Params();
680-
params.withIndicesOptions(getAliasesRequest.indicesOptions());
719+
if (GetAliasesRequest.DEFAULT_INDICES_OPTIONS.equals(getAliasesRequest.indicesOptions()) == false) {
720+
params.withIndicesOptions(getAliasesRequest.indicesOptions());
721+
}
681722
params.withLocal(getAliasesRequest.local());
682723
request.addParameters(params.asMap());
683724
return request;
@@ -807,7 +848,9 @@ static Request reloadAnalyzers(ReloadAnalyzersRequest reloadAnalyzersRequest) {
807848
String endpoint = RequestConverters.endpoint(reloadAnalyzersRequest.getIndices(), "_reload_search_analyzers");
808849
Request request = new Request(HttpPost.METHOD_NAME, endpoint);
809850
RequestConverters.Params parameters = new RequestConverters.Params();
810-
parameters.withIndicesOptions(reloadAnalyzersRequest.indicesOptions());
851+
if (ReloadAnalyzersRequest.DEFAULT_INDICES_OPTIONS.equals(reloadAnalyzersRequest.indicesOptions()) == false) {
852+
parameters.withIndicesOptions(reloadAnalyzersRequest.indicesOptions());
853+
}
811854
request.addParameters(parameters.asMap());
812855
return request;
813856
}

0 commit comments

Comments
 (0)