WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
Get Snapshots APIedit
Use the Get Snapshot API to get snapshots.
Get Snapshots Requestedit
A GetSnapshotsRequest
:
GetSnapshotsRequest request = new GetSnapshotsRequest();
Required Argumentsedit
The following arguments are mandatory:
Optional Argumentsedit
The following arguments are optional:
Timeout to connect to the master node as a |
|
Timeout to connect to the master node as a |
Synchronous Executionedit
GetSnapshotsResponse response = client.snapshot().get(request, RequestOptions.DEFAULT);
Asynchronous Executionedit
The asynchronous execution of a get snapshots request requires both the
GetSnapshotsRequest
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 GetSnapshotsResponse
looks like:
Get Snapshots Responseedit
The returned GetSnapshotsResponse
allows the retrieval of information about the requested
snapshots:
List<SnapshotInfo> snapshotsInfos = response.getSnapshots(); SnapshotInfo snapshotInfo = snapshotsInfos.get(0); RestStatus restStatus = snapshotInfo.status(); SnapshotId snapshotId = snapshotInfo.snapshotId(); SnapshotState snapshotState = snapshotInfo.state(); List<SnapshotShardFailure> snapshotShardFailures = snapshotInfo.shardFailures(); long startTime = snapshotInfo.startTime(); long endTime = snapshotInfo.endTime();