IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete Snapshot API
editDelete Snapshot API
editThe Delete Snapshot API allows to delete a snapshot.
Delete Snapshot Request
editA DeleteSnapshotRequest
:
DeleteSnapshotRequest request = new DeleteSnapshotRequest(repositoryName); request.snapshot(snapshotName);
Optional Arguments
editThe following arguments can optionally be provided:
Synchronous Execution
editAcknowledgedResponse response = client.snapshot().delete(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of a delete snapshot request requires both the
DeleteSnapshotRequest
instance and an ActionListener
instance to be
passed to the asynchronous method:
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:
Delete Snapshot Response
editThe returned DeleteSnapshotResponse
allows to retrieve information about the
executed operation as follows: