Package co.elastic.clients.elasticsearch.cat

Class SnapshotsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.SnapshotsRequest
public class SnapshotsRequest extends CatRequestBase
Get snapshot information.

Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

See Also:

  • Field Details

  • Method Details

    • of

      public static SnapshotsRequest of(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)

    • bytes

      @Nullable public final Bytes bytes()
      Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: bytes

    • h

      public final List<String> h()
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If true, the response does not include information from unavailable snapshots.

      API name: ignore_unavailable

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node.

      API name: master_timeout

    • repository

      public final List<String> repository()
      A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

      API name: repository

    • s

      public final List<String> s()
      List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      API name: s

    • time

      @Nullable public final TimeUnit time()
      Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: time