Close Job API

The Close Job API provides the ability to close machine learning jobs in the cluster. It accepts a CloseJobRequest object and responds with a CloseJobResponse object.

Close Job Request

A CloseJobRequest object gets created with an existing non-null jobId.

CloseJobRequest closeJobRequest = new CloseJobRequest("closing-my-first-machine-learning-job", "otherjobs*"); 
closeJobRequest.setForce(false); 
closeJobRequest.setAllowNoJobs(true); 
closeJobRequest.setTimeout(TimeValue.timeValueMinutes(10)); 

Constructing a new request referencing existing job IDs

Optionally used to close a failed job, or to forcefully close a job which has not responded to its initial close request.

Optionally set to ignore if a wildcard expression matches no jobs. (This includes _all string or when no jobs have been specified)

Optionally setting the timeout value for how long the execution should wait for the job to be closed.

Close Job Response

boolean isClosed = closeJobResponse.isClosed(); 

isClosed() from the CloseJobResponse indicates if the job was successfully closed or not.

Synchronous Execution

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

CloseJobResponse closeJobResponse = client.machineLearning().closeJob(closeJobRequest, 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 CloseJobRequest 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 close-job method:

client.machineLearning().closeJobAsync(closeJobRequest, RequestOptions.DEFAULT, listener); 

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

ActionListener<CloseJobResponse> listener = new ActionListener<CloseJobResponse>() {
    @Override
    public void onResponse(CloseJobResponse closeJobResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole CloseJobRequest fails.