Package co.elastic.clients.elasticsearch.cat

Class HealthRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.HealthRequest
public class HealthRequest extends CatRequestBase
Get the cluster health status.

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 cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

See Also:

  • Field Details

  • Method Details

    • of

      public static HealthRequest of(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> 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

    • 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

    • ts

      @Nullable public final Boolean ts()
      If true, returns HH:MM:SS and Unix epoch timestamps.

      API name: ts