[2.x] Deprecate public methods and variables with master term in pack…

…age 'org.opensearch.action.support.master' (#3617) (#3643) Replace `master` terminology by `cluster manager` in the public Java APIs to support inclusive language. The commit deal with the public method and variable in the package `org.opensearch.action.support.master` (which is now renamed to `org.opensearch.action.support.clustermanager`) - Rename public methods and variables with "master" name (listed below) by "cluster manager", including all the references to the methods/variables. - Add back the methods and variables in the old name, point them to call the method/variable in new name, and add `deprecated` annotation to them. Signed-off-by: Tianli Feng <[email protected]>
opensearch-project · Jun 22, 2022 · 79cabaf · 79cabaf
1 parent 4f340b3
commit 79cabaf
Show file tree

Hide file tree

Showing 184 changed files with 594 additions and 372 deletions.
diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/ClusterRequestConverters.java b/client/rest-high-level/src/main/java/org/opensearch/client/ClusterRequestConverters.java
@@ -58,7 +58,7 @@ static Request clusterPutSettings(ClusterUpdateSettingsRequest clusterUpdateSett
 
         RequestConverters.Params parameters = new RequestConverters.Params();
         parameters.withTimeout(clusterUpdateSettingsRequest.timeout());
-        parameters.withMasterTimeout(clusterUpdateSettingsRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(clusterUpdateSettingsRequest.clusterManagerNodeTimeout());
         request.addParameters(parameters.asMap());
         request.setEntity(RequestConverters.createEntity(clusterUpdateSettingsRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
         return request;
@@ -69,7 +69,7 @@ static Request clusterGetSettings(ClusterGetSettingsRequest clusterGetSettingsRe
         RequestConverters.Params parameters = new RequestConverters.Params();
         parameters.withLocal(clusterGetSettingsRequest.local());
         parameters.withIncludeDefaults(clusterGetSettingsRequest.includeDefaults());
-        parameters.withMasterTimeout(clusterGetSettingsRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(clusterGetSettingsRequest.clusterManagerNodeTimeout());
         request.addParameters(parameters.asMap());
         return request;
     }
@@ -88,7 +88,7 @@ static Request clusterHealth(ClusterHealthRequest healthRequest) {
             .withWaitForNodes(healthRequest.waitForNodes())
             .withWaitForEvents(healthRequest.waitForEvents())
             .withTimeout(healthRequest.timeout())
-            .withMasterTimeout(healthRequest.masterNodeTimeout())
+            .withMasterTimeout(healthRequest.clusterManagerNodeTimeout())
             .withLocal(healthRequest.local())
             .withLevel(healthRequest.level());
         request.addParameters(params.asMap());

diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/IndicesRequestConverters.java b/client/rest-high-level/src/main/java/org/opensearch/client/IndicesRequestConverters.java
@@ -119,7 +119,7 @@ static Request deleteIndex(DeleteIndexRequest deleteIndexRequest) {
 
         RequestConverters.Params parameters = new RequestConverters.Params();
         parameters.withTimeout(deleteIndexRequest.timeout());
-        parameters.withMasterTimeout(deleteIndexRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(deleteIndexRequest.clusterManagerNodeTimeout());
         parameters.withIndicesOptions(deleteIndexRequest.indicesOptions());
         request.addParameters(parameters.asMap());
         return request;
@@ -131,7 +131,7 @@ static Request openIndex(OpenIndexRequest openIndexRequest) {
 
         RequestConverters.Params parameters = new RequestConverters.Params();
         parameters.withTimeout(openIndexRequest.timeout());
-        parameters.withMasterTimeout(openIndexRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(openIndexRequest.clusterManagerNodeTimeout());
         parameters.withWaitForActiveShards(openIndexRequest.waitForActiveShards());
         parameters.withIndicesOptions(openIndexRequest.indicesOptions());
         request.addParameters(parameters.asMap());
@@ -168,7 +168,7 @@ static Request updateAliases(IndicesAliasesRequest indicesAliasesRequest) throws
 
         RequestConverters.Params parameters = new RequestConverters.Params();
         parameters.withTimeout(indicesAliasesRequest.timeout());
-        parameters.withMasterTimeout(indicesAliasesRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(indicesAliasesRequest.clusterManagerNodeTimeout());
         request.addParameters(parameters.asMap());
         request.setEntity(RequestConverters.createEntity(indicesAliasesRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
         return request;
@@ -349,7 +349,7 @@ private static Request resize(org.opensearch.action.admin.indices.shrink.ResizeR
 
         RequestConverters.Params params = new RequestConverters.Params();
         params.withTimeout(resizeRequest.timeout());
-        params.withMasterTimeout(resizeRequest.masterNodeTimeout());
+        params.withMasterTimeout(resizeRequest.clusterManagerNodeTimeout());
         params.withWaitForActiveShards(resizeRequest.getTargetIndexRequest().waitForActiveShards());
         request.addParameters(params.asMap());
         request.setEntity(RequestConverters.createEntity(resizeRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
@@ -386,7 +386,7 @@ static Request getSettings(GetSettingsRequest getSettingsRequest) {
         params.withIndicesOptions(getSettingsRequest.indicesOptions());
         params.withLocal(getSettingsRequest.local());
         params.withIncludeDefaults(getSettingsRequest.includeDefaults());
-        params.withMasterTimeout(getSettingsRequest.masterNodeTimeout());
+        params.withMasterTimeout(getSettingsRequest.clusterManagerNodeTimeout());
         request.addParameters(params.asMap());
         return request;
     }
@@ -429,7 +429,7 @@ static Request indexPutSettings(UpdateSettingsRequest updateSettingsRequest) thr
 
         RequestConverters.Params parameters = new RequestConverters.Params();
         parameters.withTimeout(updateSettingsRequest.timeout());
-        parameters.withMasterTimeout(updateSettingsRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(updateSettingsRequest.clusterManagerNodeTimeout());
         parameters.withIndicesOptions(updateSettingsRequest.indicesOptions());
         parameters.withPreserveExisting(updateSettingsRequest.isPreserveExisting());
         request.addParameters(parameters.asMap());
@@ -443,7 +443,7 @@ static Request putTemplate(PutIndexTemplateRequest putIndexTemplateRequest) thro
             .build();
         Request request = new Request(HttpPut.METHOD_NAME, endpoint);
         RequestConverters.Params params = new RequestConverters.Params();
-        params.withMasterTimeout(putIndexTemplateRequest.masterNodeTimeout());
+        params.withMasterTimeout(putIndexTemplateRequest.clusterManagerNodeTimeout());
         if (putIndexTemplateRequest.create()) {
             params.putParam("create", Boolean.TRUE.toString());
         }
@@ -587,7 +587,7 @@ static Request deleteTemplate(DeleteIndexTemplateRequest deleteIndexTemplateRequ
         String endpoint = new RequestConverters.EndpointBuilder().addPathPartAsIs("_template").addPathPart(name).build();
         Request request = new Request(HttpDelete.METHOD_NAME, endpoint);
         RequestConverters.Params params = new RequestConverters.Params();
-        params.withMasterTimeout(deleteIndexTemplateRequest.masterNodeTimeout());
+        params.withMasterTimeout(deleteIndexTemplateRequest.clusterManagerNodeTimeout());
         request.addParameters(params.asMap());
         return request;
     }

diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/IngestRequestConverters.java b/client/rest-high-level/src/main/java/org/opensearch/client/IngestRequestConverters.java
@@ -54,7 +54,7 @@ static Request getPipeline(GetPipelineRequest getPipelineRequest) {
         Request request = new Request(HttpGet.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(getPipelineRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(getPipelineRequest.clusterManagerNodeTimeout());
         request.addParameters(parameters.asMap());
         return request;
     }
@@ -67,7 +67,7 @@ static Request putPipeline(PutPipelineRequest putPipelineRequest) throws IOExcep
 
         RequestConverters.Params parameters = new RequestConverters.Params();
         parameters.withTimeout(putPipelineRequest.timeout());
-        parameters.withMasterTimeout(putPipelineRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(putPipelineRequest.clusterManagerNodeTimeout());
         request.addParameters(parameters.asMap());
         request.setEntity(RequestConverters.createEntity(putPipelineRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
         return request;
@@ -81,7 +81,7 @@ static Request deletePipeline(DeletePipelineRequest deletePipelineRequest) {
 
         RequestConverters.Params parameters = new RequestConverters.Params();
         parameters.withTimeout(deletePipelineRequest.timeout());
-        parameters.withMasterTimeout(deletePipelineRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(deletePipelineRequest.clusterManagerNodeTimeout());
         request.addParameters(parameters.asMap());
         return request;
     }

diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/RequestConverters.java b/client/rest-high-level/src/main/java/org/opensearch/client/RequestConverters.java
@@ -702,7 +702,7 @@ static Request putScript(PutStoredScriptRequest putStoredScriptRequest) throws I
         Request request = new Request(HttpPost.METHOD_NAME, endpoint);
         Params params = new Params();
         params.withTimeout(putStoredScriptRequest.timeout());
-        params.withMasterTimeout(putStoredScriptRequest.masterNodeTimeout());
+        params.withMasterTimeout(putStoredScriptRequest.clusterManagerNodeTimeout());
         if (Strings.hasText(putStoredScriptRequest.context())) {
             params.putParam("context", putStoredScriptRequest.context());
         }
@@ -757,7 +757,7 @@ static Request getScript(GetStoredScriptRequest getStoredScriptRequest) {
         String endpoint = new EndpointBuilder().addPathPartAsIs("_scripts").addPathPart(getStoredScriptRequest.id()).build();
         Request request = new Request(HttpGet.METHOD_NAME, endpoint);
         Params params = new Params();
-        params.withMasterTimeout(getStoredScriptRequest.masterNodeTimeout());
+        params.withMasterTimeout(getStoredScriptRequest.clusterManagerNodeTimeout());
         request.addParameters(params.asMap());
         return request;
     }
@@ -767,7 +767,7 @@ static Request deleteScript(DeleteStoredScriptRequest deleteStoredScriptRequest)
         Request request = new Request(HttpDelete.METHOD_NAME, endpoint);
         Params params = new Params();
         params.withTimeout(deleteStoredScriptRequest.timeout());
-        params.withMasterTimeout(deleteStoredScriptRequest.masterNodeTimeout());
+        params.withMasterTimeout(deleteStoredScriptRequest.clusterManagerNodeTimeout());
         request.addParameters(params.asMap());
         return request;
     }

diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/SnapshotRequestConverters.java b/client/rest-high-level/src/main/java/org/opensearch/client/SnapshotRequestConverters.java
@@ -63,7 +63,7 @@ static Request getRepositories(GetRepositoriesRequest getRepositoriesRequest) {
         Request request = new Request(HttpGet.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(getRepositoriesRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(getRepositoriesRequest.clusterManagerNodeTimeout());
         parameters.withLocal(getRepositoriesRequest.local());
         request.addParameters(parameters.asMap());
         return request;
@@ -74,7 +74,7 @@ static Request createRepository(PutRepositoryRequest putRepositoryRequest) throw
         Request request = new Request(HttpPut.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(putRepositoryRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(putRepositoryRequest.clusterManagerNodeTimeout());
         parameters.withTimeout(putRepositoryRequest.timeout());
         if (putRepositoryRequest.verify() == false) {
             parameters.putParam("verify", "false");
@@ -91,7 +91,7 @@ static Request deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
         Request request = new Request(HttpDelete.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(deleteRepositoryRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(deleteRepositoryRequest.clusterManagerNodeTimeout());
         parameters.withTimeout(deleteRepositoryRequest.timeout());
         request.addParameters(parameters.asMap());
         return request;
@@ -105,7 +105,7 @@ static Request verifyRepository(VerifyRepositoryRequest verifyRepositoryRequest)
         Request request = new Request(HttpPost.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(verifyRepositoryRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(verifyRepositoryRequest.clusterManagerNodeTimeout());
         parameters.withTimeout(verifyRepositoryRequest.timeout());
         request.addParameters(parameters.asMap());
         return request;
@@ -119,7 +119,7 @@ static Request cleanupRepository(CleanupRepositoryRequest cleanupRepositoryReque
         Request request = new Request(HttpPost.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(cleanupRepositoryRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(cleanupRepositoryRequest.clusterManagerNodeTimeout());
         parameters.withTimeout(cleanupRepositoryRequest.timeout());
         request.addParameters(parameters.asMap());
         return request;
@@ -132,7 +132,7 @@ static Request createSnapshot(CreateSnapshotRequest createSnapshotRequest) throw
             .build();
         Request request = new Request(HttpPut.METHOD_NAME, endpoint);
         RequestConverters.Params params = new RequestConverters.Params();
-        params.withMasterTimeout(createSnapshotRequest.masterNodeTimeout());
+        params.withMasterTimeout(createSnapshotRequest.clusterManagerNodeTimeout());
         params.withWaitForCompletion(createSnapshotRequest.waitForCompletion());
         request.addParameters(params.asMap());
         request.setEntity(RequestConverters.createEntity(createSnapshotRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
@@ -148,7 +148,7 @@ static Request cloneSnapshot(CloneSnapshotRequest cloneSnapshotRequest) throws I
             .build();
         Request request = new Request(HttpPut.METHOD_NAME, endpoint);
         RequestConverters.Params params = new RequestConverters.Params();
-        params.withMasterTimeout(cloneSnapshotRequest.masterNodeTimeout());
+        params.withMasterTimeout(cloneSnapshotRequest.clusterManagerNodeTimeout());
         request.addParameters(params.asMap());
         request.setEntity(RequestConverters.createEntity(cloneSnapshotRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
         return request;
@@ -167,7 +167,7 @@ static Request getSnapshots(GetSnapshotsRequest getSnapshotsRequest) {
         Request request = new Request(HttpGet.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(getSnapshotsRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(getSnapshotsRequest.clusterManagerNodeTimeout());
         parameters.putParam("ignore_unavailable", Boolean.toString(getSnapshotsRequest.ignoreUnavailable()));
         parameters.putParam("verbose", Boolean.toString(getSnapshotsRequest.verbose()));
         request.addParameters(parameters.asMap());
@@ -183,7 +183,7 @@ static Request snapshotsStatus(SnapshotsStatusRequest snapshotsStatusRequest) {
         Request request = new Request(HttpGet.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(snapshotsStatusRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(snapshotsStatusRequest.clusterManagerNodeTimeout());
         parameters.withIgnoreUnavailable(snapshotsStatusRequest.ignoreUnavailable());
         request.addParameters(parameters.asMap());
         return request;
@@ -197,7 +197,7 @@ static Request restoreSnapshot(RestoreSnapshotRequest restoreSnapshotRequest) th
             .build();
         Request request = new Request(HttpPost.METHOD_NAME, endpoint);
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(restoreSnapshotRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(restoreSnapshotRequest.clusterManagerNodeTimeout());
         parameters.withWaitForCompletion(restoreSnapshotRequest.waitForCompletion());
         request.addParameters(parameters.asMap());
         request.setEntity(RequestConverters.createEntity(restoreSnapshotRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
@@ -212,7 +212,7 @@ static Request deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) {
         Request request = new Request(HttpDelete.METHOD_NAME, endpoint);
 
         RequestConverters.Params parameters = new RequestConverters.Params();
-        parameters.withMasterTimeout(deleteSnapshotRequest.masterNodeTimeout());
+        parameters.withMasterTimeout(deleteSnapshotRequest.clusterManagerNodeTimeout());
         request.addParameters(parameters.asMap());
         return request;
     }

diff --git a/...nt/rest-high-level/src/test/java/org/opensearch/client/ClusterRequestConvertersTests.java b/...nt/rest-high-level/src/test/java/org/opensearch/client/ClusterRequestConvertersTests.java
@@ -101,13 +101,13 @@ public void testClusterHealth() {
                 break;
             case "masterTimeout":
                 expectedParams.put("timeout", "30s");
-                healthRequest.masterNodeTimeout(clusterManagerTimeout);
+                healthRequest.clusterManagerNodeTimeout(clusterManagerTimeout);
                 expectedParams.put("master_timeout", clusterManagerTimeout);
                 break;
             case "both":
                 healthRequest.timeout(timeout);
                 expectedParams.put("timeout", timeout);
-                healthRequest.masterNodeTimeout(timeout);
+                healthRequest.clusterManagerNodeTimeout(timeout);
                 expectedParams.put("master_timeout", timeout);
                 break;
             case "none":

diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/RequestConvertersTests.java b/client/rest-high-level/src/test/java/org/opensearch/client/RequestConvertersTests.java
@@ -2106,7 +2106,7 @@ static void setRandomTimeoutTimeValue(Consumer<TimeValue> setter, TimeValue defa
     }
 
     static void setRandomMasterTimeout(ClusterManagerNodeRequest<?> request, Map<String, String> expectedParams) {
-        setRandomMasterTimeout(request::masterNodeTimeout, expectedParams);
+        setRandomMasterTimeout(request::clusterManagerNodeTimeout, expectedParams);
     }
 
     static void setRandomMasterTimeout(TimedRequest request, Map<String, String> expectedParams) {
@@ -2122,7 +2122,7 @@ static void setRandomMasterTimeout(Consumer<String> setter, Map<String, String>
             setter.accept(masterTimeout);
             expectedParams.put("master_timeout", masterTimeout);
         } else {
-            expectedParams.put("master_timeout", ClusterManagerNodeRequest.DEFAULT_MASTER_NODE_TIMEOUT.getStringRep());
+            expectedParams.put("master_timeout", ClusterManagerNodeRequest.DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT.getStringRep());
         }
     }
 

diff --git a/...t/rest-high-level/src/test/java/org/opensearch/client/SnapshotRequestConvertersTests.java b/...t/rest-high-level/src/test/java/org/opensearch/client/SnapshotRequestConvertersTests.java
@@ -263,7 +263,7 @@ public void testRestoreSnapshot() throws IOException {
 
         if (randomBoolean()) {
             String timeout = randomTimeValue();
-            restoreSnapshotRequest.masterNodeTimeout(timeout);
+            restoreSnapshotRequest.clusterManagerNodeTimeout(timeout);
             expectedParams.put("master_timeout", timeout);
         }
 

diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/StoredScriptsIT.java b/client/rest-high-level/src/test/java/org/opensearch/client/StoredScriptsIT.java
@@ -65,7 +65,7 @@ public void testGetStoredScript() throws Exception {
         assertAcked(execute(request, highLevelClient()::putScript, highLevelClient()::putScriptAsync));
 
         GetStoredScriptRequest getRequest = new GetStoredScriptRequest("calculate-score");
-        getRequest.masterNodeTimeout("50s");
+        getRequest.clusterManagerNodeTimeout("50s");
 
         GetStoredScriptResponse getResponse = execute(getRequest, highLevelClient()::getScript, highLevelClient()::getScriptAsync);
 
@@ -83,7 +83,7 @@ public void testDeleteStoredScript() throws Exception {
         assertAcked(execute(request, highLevelClient()::putScript, highLevelClient()::putScriptAsync));
 
         DeleteStoredScriptRequest deleteRequest = new DeleteStoredScriptRequest(id);
-        deleteRequest.masterNodeTimeout("50s");
+        deleteRequest.clusterManagerNodeTimeout("50s");
         deleteRequest.timeout("50s");
         assertAcked(execute(deleteRequest, highLevelClient()::deleteScript, highLevelClient()::deleteScriptAsync));