Create Snapshot API
editCreate Snapshot API
editUse the Create Snapshot API to create a new snapshot.
Create Snapshot Request
editA CreateSnapshotRequest
:
CreateSnapshotRequest request = new CreateSnapshotRequest();
Required Arguments
editThe following arguments are mandatory:
Optional Arguments
editThe following arguments are optional:
Set |
Set |
Timeout to connect to the master node as a |
|
Timeout to connect to the master node as a |
Synchronous Execution
editExecute a CreateSnapshotRequest
synchronously to receive a CreateSnapshotResponse
.
CreateSnapshotResponse response = client.snapshot().create(request, RequestOptions.DEFAULT);
Retrieve the SnapshotInfo
from a CreateSnapshotResponse
when the snapshot is fully created.
(The waitForCompletion
parameter is true
).
Asynchronous Execution
editThe asynchronous execution of a create snapshot request requires both the
CreateSnapshotRequest
instance and an ActionListener
instance to be
passed as arguments to the asynchronous method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back with the onResponse
method
if the execution is successful or the onFailure
method if the execution
failed.
A typical listener for CreateSnapshotResponse
looks like:
Snapshot Create Response
editUse the CreateSnapshotResponse
to retrieve information about the evaluated
request: