Revert model snapshots APIedit

Reverts to a previous machine learning model snapshot. It accepts a RevertModelSnapshotRequest object and responds with a RevertModelSnapshotResponse object.

Revert model snapshots requestedit

A RevertModelSnapshotRequest requires the following arguments:

RevertModelSnapshotRequest request = new RevertModelSnapshotRequest(jobId, snapshotId); 

Constructing a new request referencing existing jobId and snapshotId values.

Optional argumentsedit

The following arguments are optional:


A flag indicating whether or not results in the period between the timestamp on the reverted snapshot and the latest results should be deleted

Synchronous executionedit

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

RevertModelSnapshotResponse response = client.machineLearning().revertModelSnapshot(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 RevertModelSnapshotRequest 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 revert-model-snapshot method:

client.machineLearning().revertModelSnapshotAsync(request, RequestOptions.DEFAULT, listener); 

The RevertModelSnapshotRequest 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 revert-model-snapshot looks like:

ActionListener<RevertModelSnapshotResponse> listener =
    new ActionListener<RevertModelSnapshotResponse>() {
        public void onResponse(RevertModelSnapshotResponse revertModelSnapshotResponse) {

        public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole RevertModelSnapshotRequest fails.

Revert job responseedit

A RevertModelSnapshotResponse contains the full representation of the reverted ModelSnapshot.

ModelSnapshot modelSnapshot = response.getModel(); 

The reverted ModelSnapshot