Class SnapshotsStatusRequestBuilder
- java.lang.Object
-
- org.elasticsearch.action.ActionRequestBuilder<Request,Response>
-
- org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<SnapshotsStatusRequest,SnapshotsStatusResponse,SnapshotsStatusRequestBuilder>
-
- org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotsStatusRequestBuilder
-
public class SnapshotsStatusRequestBuilder extends MasterNodeOperationRequestBuilder<SnapshotsStatusRequest,SnapshotsStatusResponse,SnapshotsStatusRequestBuilder>
Snapshots status request builder
-
-
Field Summary
-
Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
action, client, request
-
-
Constructor Summary
Constructors Constructor Description SnapshotsStatusRequestBuilder(ElasticsearchClient client, SnapshotsStatusAction action)
Constructs the new snapshot status requestSnapshotsStatusRequestBuilder(ElasticsearchClient client, SnapshotsStatusAction action, java.lang.String repository)
Constructs the new snapshot status request with specified repository
-
Method Summary
Modifier and Type Method Description SnapshotsStatusRequestBuilder
addSnapshots(java.lang.String... snapshots)
Adds additional snapshots to the list of snapshots to returnSnapshotsStatusRequestBuilder
setIgnoreUnavailable(boolean ignoreUnavailable)
Set totrue
to ignore unavailable snapshots, instead of throwing an exception.SnapshotsStatusRequestBuilder
setRepository(java.lang.String repository)
Sets the repository nameSnapshotsStatusRequestBuilder
setSnapshots(java.lang.String... snapshots)
Sets list of snapshots to return-
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder
setMasterNodeTimeout, setMasterNodeTimeout
-
-
-
-
Constructor Detail
-
SnapshotsStatusRequestBuilder
public SnapshotsStatusRequestBuilder(ElasticsearchClient client, SnapshotsStatusAction action)
Constructs the new snapshot status request
-
SnapshotsStatusRequestBuilder
public SnapshotsStatusRequestBuilder(ElasticsearchClient client, SnapshotsStatusAction action, java.lang.String repository)
Constructs the new snapshot status request with specified repository
-
-
Method Detail
-
setRepository
public SnapshotsStatusRequestBuilder setRepository(java.lang.String repository)
Sets the repository name- Parameters:
repository
- repository name- Returns:
- this builder
-
setSnapshots
public SnapshotsStatusRequestBuilder setSnapshots(java.lang.String... snapshots)
Sets list of snapshots to return- Parameters:
snapshots
- list of snapshots- Returns:
- this builder
-
addSnapshots
public SnapshotsStatusRequestBuilder addSnapshots(java.lang.String... snapshots)
Adds additional snapshots to the list of snapshots to return- Parameters:
snapshots
- additional snapshots- Returns:
- this builder
-
setIgnoreUnavailable
public SnapshotsStatusRequestBuilder setIgnoreUnavailable(boolean ignoreUnavailable)
Set totrue
to ignore unavailable snapshots, instead of throwing an exception. Defaults tofalse
, which means unavailable snapshots cause an exception to be thrown.- Parameters:
ignoreUnavailable
- whether to ignore unavailable snapshots.- Returns:
- this builder
-
-