Get Data Frame Analytics APIedit

The Get Data Frame Analytics API is used to get one or more data frame analytics configs. The API accepts a GetDataFrameAnalyticsRequest object and returns a GetDataFrameAnalyticsResponse.

Get Data Frame Analytics Requestedit

A GetDataFrameAnalyticsRequest requires either a data frame analytics config id, a comma separated list of ids or the special wildcard _all to get all data frame analytics configs.

GetDataFrameAnalyticsRequest request = new GetDataFrameAnalyticsRequest("my-analytics-config"); 

Constructing a new GET request referencing an existing data frame analytics config

Synchronous executionedit

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

GetDataFrameAnalyticsResponse response = client.machineLearning().getDataFrameAnalytics(request, 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 executionedit

Executing a GetDataFrameAnalyticsRequest 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-data-frame-analytics method:

client.machineLearning().getDataFrameAnalyticsAsync(request, RequestOptions.DEFAULT, listener); 

The GetDataFrameAnalyticsRequest 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-data-frame-analytics looks like:

ActionListener<GetDataFrameAnalyticsResponse> listener = new ActionListener<GetDataFrameAnalyticsResponse>() {
    @Override
    public void onResponse(GetDataFrameAnalyticsResponse response) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole GetDataFrameAnalyticsRequest fails.

Responseedit

The returned GetDataFrameAnalyticsResponse contains the requested data frame analytics configs.

List<DataFrameAnalyticsConfig> configs = response.getAnalytics();