IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete calendars API Delete datafeeds API »
Elastic Docs ›Java REST Client [7.10] ›Java High Level REST Client ›Machine Learning APIs

Delete data frame analytics jobs API

edit

Delete data frame analytics jobs API

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Delete an existing data frame analytics job. The API accepts a DeleteDataFrameAnalyticsRequest object as a request and returns a AcknowledgedResponse.

Delete data frame analytics jobs request

edit

A DeleteDataFrameAnalyticsRequest object requires a data frame analytics job ID.

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

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

Optional arguments

edit

The following arguments are optional:

request.setForce(false); 
request.setTimeout(TimeValue.timeValueMinutes(1));

Use to forcefully delete a job that is not stopped. This method is quicker than stopping and deleting the job. Defaults to false.

Use to set the time to wait until the job is deleted. Defaults to 1 minute.

Synchronous execution

edit

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

AcknowledgedResponse response = client.machineLearning().deleteDataFrameAnalytics(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 execution

edit

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

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

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

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

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

Called when the execution is successfully completed.

Called when the whole DeleteDataFrameAnalyticsRequest fails.

Response

edit

The returned AcknowledgedResponse object acknowledges the data frame analytics job deletion.

« Delete calendars API Delete datafeeds API »