Class GetSnapshotsRequest

All Implemented Interfaces:
Writeable, TaskAwareRequest

public class GetSnapshotsRequest
extends MasterNodeRequest<GetSnapshotsRequest>
Get snapshot request
  • Field Details

  • Constructor Details

    • GetSnapshotsRequest

      public GetSnapshotsRequest()
    • GetSnapshotsRequest

      public GetSnapshotsRequest​(java.lang.String repository, java.lang.String[] snapshots)
      Constructs a new get snapshots request with given repository name and list of snapshots
      Parameters:
      repository - repository name
      snapshots - list of snapshots
    • GetSnapshotsRequest

      public GetSnapshotsRequest​(java.lang.String repository)
      Constructs a new get snapshots request with given repository name
      Parameters:
      repository - repository name
    • GetSnapshotsRequest

      public GetSnapshotsRequest​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException
  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Overrides:
      writeTo in class MasterNodeRequest<GetSnapshotsRequest>
      Throws:
      java.io.IOException
    • validate

      Specified by:
      validate in class ActionRequest
    • repository

      public GetSnapshotsRequest repository​(java.lang.String repository)
      Sets repository name
      Parameters:
      repository - repository name
      Returns:
      this request
    • repository

      public java.lang.String repository()
      Returns repository name
      Returns:
      repository name
    • snapshots

      public java.lang.String[] snapshots()
      Returns the names of the snapshots.
      Returns:
      the names of snapshots
    • snapshots

      public GetSnapshotsRequest snapshots​(java.lang.String[] snapshots)
      Sets the list of snapshots to be returned
      Returns:
      this request
    • ignoreUnavailable

      public GetSnapshotsRequest ignoreUnavailable​(boolean ignoreUnavailable)
      Set to true to ignore unavailable snapshots
      Returns:
      this request
    • ignoreUnavailable

      public boolean ignoreUnavailable()
      Returns:
      Whether snapshots should be ignored when unavailable (corrupt or temporarily not fetchable)
    • verbose

      public GetSnapshotsRequest verbose​(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.
    • verbose

      public boolean verbose()
      Returns whether the request will return a verbose response.