New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Snapshots Status API Tasks APIs »
Elastic Docs ›Java REST Client [6.4] ›Java High Level REST Client ›Snapshot APIs

Delete Snapshot API

edit

Delete Snapshot API

edit

The Delete Snapshot API allows to delete a snapshot.

Delete Snapshot Request

edit

A DeleteSnapshotRequest:

DeleteSnapshotRequest request = new DeleteSnapshotRequest(repositoryName);
request.snapshot(snapshotName);

Optional Arguments

edit

The following arguments can optionally be provided:

request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); 
request.masterNodeTimeout("1m");

Timeout to connect to the master node as a TimeValue

Timeout to connect to the master node as a String

Synchronous Execution

edit
DeleteSnapshotResponse response = client.snapshot().delete(request, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution of a delete snapshot request requires both the DeleteSnapshotRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.snapshot().deleteAsync(request, RequestOptions.DEFAULT, listener);

The DeleteSnapshotRequest 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 DeleteSnapshotResponse looks like:

ActionListener<DeleteSnapshotResponse> listener =
    new ActionListener<DeleteSnapshotResponse>() {
        @Override
        public void onResponse(DeleteSnapshotResponse deleteSnapshotResponse) {
            
        }

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

Called when the execution is successfully completed. The response is provided as an argument

Called in case of a failure. The raised exception is provided as an argument

Delete Snapshot Response

edit

The returned DeleteSnapshotResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = response.isAcknowledged();

Indicates the node has acknowledged the request
« Snapshots Status API Tasks APIs »