Package org.opensearch.client.opensearch.nodes

Class NodesStatsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.nodes.NodesStatsRequest
All Implemented Interfaces:
ToCopyableBuilder<NodesStatsRequest.Builder,NodesStatsRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class NodesStatsRequest extends RequestBase implements ToCopyableBuilder<NodesStatsRequest.Builder,NodesStatsRequest>
Returns statistical information about nodes in the cluster.

  • Field Details

  • Method Details

    • of

      public static NodesStatsRequest of(Function<NodesStatsRequest.Builder,ObjectBuilder<NodesStatsRequest>> fn)

    • completionFields

      @Nonnull public final List<String> completionFields()
      A comma-separated list or wildcard expressions of fields to include in field data and suggest statistics.

      API name: completion_fields

    • fielddataFields

      @Nonnull public final List<String> fielddataFields()
      A comma-separated list or wildcard expressions of fields to include in field data statistics.

      API name: fielddata_fields

    • fields

      @Nonnull public final List<String> fields()
      A comma-separated list or wildcard expressions of fields to include in the statistics.

      API name: fields

    • groups

      @Nonnull public final List<String> groups()
      A comma-separated list of search groups to include in the search statistics.

      API name: groups

    • includeSegmentFileSizes

      @Nullable public final Boolean includeSegmentFileSizes()
      When true, reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

      API name: include_segment_file_sizes

    • indexMetric

      @Nonnull public final List<NodesStatsIndexMetric> indexMetric()
      Limit the information returned for indexes metric to the specified index metrics. It can be used only if indexes (or all) metric is specified.

      API name: index_metric

    • level

      @Nullable public final Level level()
      Indicates whether statistics are aggregated at the cluster, index, or shard level.

      API name: level

    • metric

      @Nonnull public final List<NodesStatsMetric> metric()
      Limit the information returned to the specified metrics.

      API name: metric

    • nodeId

      @Nonnull public final List<String> nodeId()
      A comma-separated list of node IDs or names used to limit returned information.

      API name: node_id

    • timeout

      @Nullable public final Time timeout()
      The amount of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • types

      @Nonnull public final List<String> types()
      A comma-separated list of document types for the indexing index metric.

      API name: types

    • toBuilder

      @Nonnull public NodesStatsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NodesStatsRequest.Builder,NodesStatsRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static NodesStatsRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object