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)
      The unit used to display byte values.

      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)
      The unit used to display time values.

      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.