Open Job API

edit

The Open Job API provides the ability to open machine learning jobs in the cluster. It accepts a OpenJobRequest object and responds with a OpenJobResponse object.

Open Job Request

edit

An OpenJobRequest object gets created with an existing non-null jobId.

OpenJobRequest openJobRequest = new OpenJobRequest("opening-my-first-machine-learning-job"); 
openJobRequest.setTimeout(TimeValue.timeValueMinutes(10)); 

Constructing a new request referencing an existing jobId

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

Open Job Response

edit
boolean isOpened = openJobResponse.isOpened(); 

isOpened() from the OpenJobResponse indicates if the job was successfully opened or not.

Synchronous Execution

edit

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

OpenJobResponse openJobResponse = client.machineLearning().openJob(openJobRequest, RequestOptions.DEFAULT);

Asynchronous Execution

edit

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

client.machineLearning().openJobAsync(openJobRequest, RequestOptions.DEFAULT, listener); 

The OpenJobRequest 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.

A typical listener for open-job looks like:

ActionListener<OpenJobResponse> listener = new ActionListener<OpenJobResponse>() {
    @Override
    public void onResponse(OpenJobResponse openJobResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole OpenJobRequest fails.