Stop Rollup Job APIedit

Requestedit

The Stop Rollup Job API allows you to stop a job by ID.

StopRollupJobRequest request = new StopRollupJobRequest(id); 
request.waitForCompletion(true);                             
request.timeout(TimeValue.timeValueSeconds(10));             

The ID of the job to stop.

Whether the request should wait that the stop operation has completed before returning (optional, defaults to false)

If wait_for_completion=true, this parameter controls how long to wait before giving up and throwing an error (optional, defaults to 30 seconds).

Responseedit

The returned StopRollupJobResponse indicates if the stop command was received.

response.isAcknowledged(); 

Whether or not the stop job request was received.

Synchronous executionedit

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

RollupClient rc = client.rollup();
StopRollupJobResponse response = rc.stopRollupJob(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 StopRollupJobRequest 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 rollup-stop-job method:

RollupClient rc = client.rollup();
rc.stopRollupJobAsync(request, RequestOptions.DEFAULT, listener); 

The StopRollupJobRequest 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 rollup-stop-job looks like:

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

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

Called when the execution is successfully completed.

Called when the whole StopRollupJobRequest fails.