Delete Model Snapshot API

Delete Model Snapshot Request

A DeleteModelSnapshotRequest object requires both a non-null jobId and a non-null snapshotId.

DeleteModelSnapshotRequest request = new DeleteModelSnapshotRequest(jobId, snapshotId); 

Constructing a new request referencing existing jobId and snapshotId.

Synchronous Execution

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

AcknowledgedResponse response = client.machineLearning().deleteModelSnapshot(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 Execution

Executing a DeleteModelSnapshotRequest 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 delete-model-snapshot method:

client.machineLearning().deleteModelSnapshotAsync(deleteModelSnapshotRequest, RequestOptions.DEFAULT, listener); 

The DeleteModelSnapshotRequest 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 delete-model-snapshot looks like:

ActionListener<AcknowledgedResponse> listener = new ActionListener<AcknowledgedResponse>() {
    @Override
    public void onResponse(AcknowledgedResponse acknowledgedResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole DeleteModelSnapshotRequest fails.

Delete Model Snapshot Response

The returned AcknowledgedResponse object indicates the acknowledgement of the request:

boolean isAcknowledged = response.isAcknowledged(); 

isAcknowledged was the deletion request acknowledged or not