Class GetSnapshotsRequestBuilder


Get snapshots request builder
  • Constructor Details

  • Method Details

    • setRepository

      public GetSnapshotsRequestBuilder setRepository(String repository)
      Sets the repository name
      Parameters:
      repository - repository name
      Returns:
      this builder
    • setRepositories

      public GetSnapshotsRequestBuilder setRepositories(String... repositories)
      Sets the repository names
      Parameters:
      repositories - repository names
      Returns:
      this builder
    • setSnapshots

      public GetSnapshotsRequestBuilder setSnapshots(String... snapshots)
      Sets list of snapshots to return
      Parameters:
      snapshots - list of snapshots
      Returns:
      this builder
    • setCurrentSnapshot

      public GetSnapshotsRequestBuilder setCurrentSnapshot()
      Makes the request to return the current snapshot
      Returns:
      this builder
    • addSnapshots

      public GetSnapshotsRequestBuilder addSnapshots(String... snapshots)
      Adds additional snapshots to the list of snapshots to return
      Parameters:
      snapshots - additional snapshots
      Returns:
      this builder
    • setIgnoreUnavailable

      public GetSnapshotsRequestBuilder setIgnoreUnavailable(boolean ignoreUnavailable)
      Makes the request ignore unavailable snapshots
      Parameters:
      ignoreUnavailable - true to ignore unavailable snapshots.
      Returns:
      this builder
    • setVerbose

      public GetSnapshotsRequestBuilder setVerbose(boolean verbose)
      Set to false 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 to true, which returns all information about each requested snapshot.
    • setAfter

      public GetSnapshotsRequestBuilder setAfter(String after)
    • setAfter

      public GetSnapshotsRequestBuilder setAfter(@Nullable GetSnapshotsRequest.After after)
    • setSort

    • setSize

      public GetSnapshotsRequestBuilder setSize(int size)
    • setOffset

      public GetSnapshotsRequestBuilder setOffset(int offset)
    • setOrder

      public GetSnapshotsRequestBuilder setOrder(SortOrder order)