Package co.elastic.clients.elasticsearch.cat

Class HealthRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<HealthRequest.Builder>
co.elastic.clients.elasticsearch.cat.HealthRequest.Builder
All Implemented Interfaces:
WithJson<HealthRequest.Builder>, ObjectBuilder<HealthRequest>
Enclosing class:
HealthRequest
public static class HealthRequest.Builder extends CatRequestBase.AbstractBuilder<HealthRequest.Builder> implements ObjectBuilder<HealthRequest>
Builder for HealthRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bytes

      public final HealthRequest.Builder bytes(@Nullable Bytes value)
      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 HealthRequest.Builder h(List<String> list)
      List of columns to appear in the response. Supports simple wildcards.

      API name: h

      Adds all elements of list to h.

    • h

      public final HealthRequest.Builder h(String value, String... values)
      List of columns to appear in the response. Supports simple wildcards.

      API name: h

      Adds one or more values to h.

    • s

      public final HealthRequest.Builder s(List<String> list)
      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

      Adds all elements of list to s.

    • s

      public final HealthRequest.Builder s(String value, String... values)
      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

      Adds one or more values to s.

    • time

      public final HealthRequest.Builder time(@Nullable TimeUnit value)
      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

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

      API name: ts

    • self

      protected HealthRequest.Builder self()
      Specified by:
      self in class CatRequestBase.AbstractBuilder<HealthRequest.Builder>

    • build

      public HealthRequest build()
      Builds a HealthRequest.
      Specified by:
      build in interface ObjectBuilder<HealthRequest>
      Throws:
      NullPointerException - if some of the required fields are null.