Package co.elastic.clients.elasticsearch.cat

Class NodesRequest

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

Get information about the nodes in a 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 nodes info API.

See Also:

  • Field Details

  • Method Details

    • of

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

    • fullId

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

      API name: full_id

    • h

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

      API name: h

    • includeUnloadedSegments

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

      API name: include_unloaded_segments

    • masterTimeout

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

      API name: master_timeout

    • s

      public final List<String> s()
      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

    • 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