Delete Job API

Delete Job Request

A DeleteJobRequest object requires a non-null jobId and can optionally set force.

DeleteJobRequest deleteJobRequest = new DeleteJobRequest("my-first-machine-learning-job"); 

Constructing a new request referencing an existing jobId

Optional Arguments

The following arguments are optional:

deleteJobRequest.setForce(false); 

Use to forcefully delete an opened job; this method is quicker than closing and deleting the job. Defaults to false.

deleteJobRequest.setWaitForCompletion(true); 

Use to set whether the request should wait until the operation has completed before returning. Defaults to true.

Delete Job Response

The returned AcknowledgedResponse object indicates the acknowledgement of the job deletion or the deletion task depending on whether the request was set to wait for completion:

Boolean isAcknowledged = deleteJobResponse.getAcknowledged(); 
TaskId task = deleteJobResponse.getTask(); 

whether was job deletion was acknowledged or not; will be null when set not to wait for completion

the id of the job deletion task; will be null when set to wait for completion

Synchronous Execution

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

DeleteJobResponse deleteJobResponse = client.machineLearning().deleteJob(deleteJobRequest, 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

Executing a DeleteJobRequest 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-job method:

client.machineLearning().deleteJobAsync(deleteJobRequest, RequestOptions.DEFAULT, listener); 

The DeleteJobRequest 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-job looks like:

ActionListener<DeleteJobResponse> listener = new ActionListener<DeleteJobResponse>() {
    @Override
    public void onResponse(DeleteJobResponse deleteJobResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole DeleteJobRequest fails.