Package co.elastic.clients.elasticsearch.cat

Class NodesRequest.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<NodesRequest.Builder>
co.elastic.clients.elasticsearch.cat.NodesRequest.Builder
All Implemented Interfaces:
WithJson<NodesRequest.Builder>, ObjectBuilder<NodesRequest>
Enclosing class:
NodesRequest
public static class NodesRequest.Builder extends CatRequestBase.AbstractBuilder<NodesRequest.Builder> implements ObjectBuilder<NodesRequest>
Builder for NodesRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bytes

      public final NodesRequest.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

    • fullId

      public final NodesRequest.Builder fullId(@Nullable Boolean value)
      If true, return the full node ID. If false, return the shortened node ID.

      API name: full_id

    • h

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

      API name: h

      Adds all elements of list to h.

    • h

      public final NodesRequest.Builder h(String value, String... values)
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

      Adds one or more values to h.

    • h

      public final NodesRequest.Builder h(CatNodeColumn value, CatNodeColumn... values)
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

      Adds one or more enum values to h.

    • includeUnloadedSegments

      public final NodesRequest.Builder includeUnloadedSegments(@Nullable Boolean value)
      If true, the response includes information from segments that are not loaded into memory.

      API name: include_unloaded_segments

    • masterTimeout

      public final NodesRequest.Builder masterTimeout(@Nullable Time value)
      The period to wait for a connection to the master node.

      API name: master_timeout

    • masterTimeout

      public final NodesRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The period to wait for a connection to the master node.

      API name: master_timeout

    • s

      public final NodesRequest.Builder s(List<String> list)
      A comma-separated list of column names or aliases that determines the sort order. 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 NodesRequest.Builder s(String value, String... values)
      A comma-separated list of column names or aliases that determines the sort order. 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 NodesRequest.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

    • self

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

    • build

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