Stop data frame analytics jobs APIedit

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Stops a running data frame analytics job. It accepts a StopDataFrameAnalyticsRequest object and responds with a StopDataFrameAnalyticsResponse object.

Stop data frame analytics jobs requestedit

A StopDataFrameAnalyticsRequest object requires a data frame analytics job ID.

StopDataFrameAnalyticsRequest request = new StopDataFrameAnalyticsRequest("my-analytics-config"); 
request.setForce(false); 

Constructing a new stop request referencing an existing data frame analytics job

Optionally used to stop a failed task

Synchronous executionedit

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

StopDataFrameAnalyticsResponse response = client.machineLearning().stopDataFrameAnalytics(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 StopDataFrameAnalyticsRequest 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 stop-data-frame-analytics method:

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

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

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

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

Called when the execution is successfully completed.

Called when the whole StopDataFrameAnalyticsRequest fails.

Responseedit

The returned StopDataFrameAnalyticsResponse object acknowledges the data frame analytics job has stopped.