Class GetSnapshotsRequestBuilder
java.lang.Object
org.elasticsearch.action.ActionRequestBuilder<Request,Response>
org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<GetSnapshotsRequest,GetSnapshotsResponse,GetSnapshotsRequestBuilder>
org.elasticsearch.action.admin.cluster.snapshots.get.GetSnapshotsRequestBuilder
public class GetSnapshotsRequestBuilder extends MasterNodeOperationRequestBuilder<GetSnapshotsRequest,GetSnapshotsResponse,GetSnapshotsRequestBuilder>
Get snapshots request builder
-
Field Summary
-
Constructor Summary
Constructors Constructor Description GetSnapshotsRequestBuilder(ElasticsearchClient client, GetSnapshotsAction action)
Constructs the new get snapshot requestGetSnapshotsRequestBuilder(ElasticsearchClient client, GetSnapshotsAction action, java.lang.String repository)
Constructs the new get snapshot request with specified repository -
Method Summary
Modifier and Type Method Description GetSnapshotsRequestBuilder
addSnapshots(java.lang.String... snapshots)
Adds additional snapshots to the list of snapshots to returnGetSnapshotsRequestBuilder
setCurrentSnapshot()
Makes the request to return the current snapshotGetSnapshotsRequestBuilder
setIgnoreUnavailable(boolean ignoreUnavailable)
Makes the request ignore unavailable snapshotsGetSnapshotsRequestBuilder
setRepository(java.lang.String repository)
Sets the repository nameGetSnapshotsRequestBuilder
setSnapshots(java.lang.String... snapshots)
Sets list of snapshots to returnGetSnapshotsRequestBuilder
setVerbose(boolean verbose)
Set tofalse
to only show the snapshot names and the indices they contain.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder
setMasterNodeTimeout, setMasterNodeTimeout
-
Constructor Details
-
GetSnapshotsRequestBuilder
Constructs the new get snapshot request -
GetSnapshotsRequestBuilder
public GetSnapshotsRequestBuilder(ElasticsearchClient client, GetSnapshotsAction action, java.lang.String repository)Constructs the new get snapshot request with specified repository
-
-
Method Details
-
setRepository
Sets the repository name- Parameters:
repository
- repository name- Returns:
- this builder
-
setSnapshots
Sets list of snapshots to return- Parameters:
snapshots
- list of snapshots- Returns:
- this builder
-
setCurrentSnapshot
Makes the request to return the current snapshot- Returns:
- this builder
-
addSnapshots
Adds additional snapshots to the list of snapshots to return- Parameters:
snapshots
- additional snapshots- Returns:
- this builder
-
setIgnoreUnavailable
Makes the request ignore unavailable snapshots- Parameters:
ignoreUnavailable
- true to ignore unavailable snapshots.- Returns:
- this builder
-
setVerbose
Set tofalse
to only show the snapshot names and the indices they contain. This is useful when the snapshots belong to a cloud-based repository where each blob read is a concern (cost wise and performance wise), as the snapshot names and indices they contain can be retrieved from a single index blob in the repository, whereas the rest of the information requires reading a snapshot metadata file for each snapshot requested. Defaults totrue
, which returns all information about each requested snapshot.
-