NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Migration Upgrade with Task API Rollup APIs »

› › ›

Get Deprecation Info

edit

Get Deprecation Info

edit

Get Deprecation Info Request

edit

A DeprecationInfoRequest can be applied to one or more indices:

List<String> indices = new ArrayList<>();
indices.add("test");
DeprecationInfoRequest deprecationInfoRequest = new DeprecationInfoRequest(indices);

Create a new request instance

Synchronous Execution

edit

When executing a DeprecationInfoRequest in the following manner, the client waits for the DeprecationInfoResponse to be returned before continuing with code execution:

DeprecationInfoResponse deprecationInfoResponse =
    client.migration().getDeprecationInfo(deprecationInfoRequest, RequestOptions.DEFAULT);

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous Execution

edit

Executing a DeprecationInfoRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous get-deprecation-info method:

client.migration().getDeprecationInfoAsync(deprecationInfoRequest,
    RequestOptions.DEFAULT, listener);

The DeprecationInfoRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for get-deprecation-info looks like:

ActionListener<DeprecationInfoResponse> listener =
    new ActionListener<DeprecationInfoResponse>() {
        @Override
        public void onResponse(DeprecationInfoResponse deprecationInfoResponse1) { 
            List<DeprecationInfoResponse.DeprecationIssue> clusterIssues =
                deprecationInfoResponse.getClusterSettingsIssues();
            List<DeprecationInfoResponse.DeprecationIssue> nodeIssues =
                deprecationInfoResponse.getNodeSettingsIssues();
            Map<String, List<DeprecationInfoResponse.DeprecationIssue>> indexIssues =
                deprecationInfoResponse.getIndexSettingsIssues();
            List<DeprecationInfoResponse.DeprecationIssue> mlIssues =
                deprecationInfoResponse.getMlSettingsIssues();
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

	Called when the execution is successfully completed.
	Called when the whole `DeprecationInfoRequest` fails.

Get Deprecation Info Response

edit

The returned DeprecationInfoResponse contains information about deprecated features currently in use at the cluster, node, and index level.

List<DeprecationInfoResponse.DeprecationIssue> clusterIssues =
    deprecationInfoResponse.getClusterSettingsIssues(); 
List<DeprecationInfoResponse.DeprecationIssue> nodeIssues =
    deprecationInfoResponse.getNodeSettingsIssues(); 
Map<String, List<DeprecationInfoResponse.DeprecationIssue>> indexIssues =
    deprecationInfoResponse.getIndexSettingsIssues(); 
List<DeprecationInfoResponse.DeprecationIssue> mlIssues =
    deprecationInfoResponse.getMlSettingsIssues();

	a List of Cluster deprecations
	a List of Node deprecations
	a Map of key IndexName, value List of deprecations for the index
	a list of Machine Learning related deprecations

« Migration Upgrade with Task API Rollup APIs »