Class SnapshotsStatusRequestBuilder

java.lang.Object

public class SnapshotsStatusRequestBuilder
extends MasterNodeOperationRequestBuilder<SnapshotsStatusRequest,​SnapshotsStatusResponse,​SnapshotsStatusRequestBuilder>
Snapshots status request builder
  • Constructor Details

    • 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 Details

    • 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 to true to ignore unavailable snapshots, instead of throwing an exception. Defaults to false, which means unavailable snapshots cause an exception to be thrown.
      Parameters:
      ignoreUnavailable - whether to ignore unavailable snapshots.
      Returns:
      this builder