Reset anomaly detection jobs APIedit

Resets an anomaly detection job that exists in the cluster.

Reset anomaly detection jobs requestedit

A ResetJobRequest object requires a non-null jobId.

ResetJobRequest resetJobRequest = new ResetJobRequest("a-job-to-reset"); 

Constructing a new request referencing an existing jobId

Optional argumentsedit

The following arguments are optional:


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

Reset anomaly detection jobs responseedit

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

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

Whether job reset was acknowledged or not. It will be null when set to not wait for completion.

The ID of the job reset task. It will be null when set to wait for completion.

Synchronous executionedit

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

ResetJobResponse resetJobResponse = client.machineLearning().resetJob(resetJobRequest, 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 ResetJobRequest 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 reset-job method:

client.machineLearning().resetJobAsync(resetJobRequest, RequestOptions.DEFAULT, listener); 

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

ActionListener<ResetJobResponse> listener = new ActionListener<ResetJobResponse>() {
    public void onResponse(ResetJobResponse resetJobResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole ResetJobRequest fails.