Package org.opensearch.client.opensearch.nodes

Class NodesStatsRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<NodesStatsRequest.Builder>
org.opensearch.client.opensearch.nodes.NodesStatsRequest.Builder
All Implemented Interfaces:
CopyableBuilder<NodesStatsRequest.Builder,NodesStatsRequest>, MutableBuilder<NodesStatsRequest.Builder,NodesStatsRequest>, ObjectBuilder<NodesStatsRequest>
Enclosing class:
NodesStatsRequest
public static class NodesStatsRequest.Builder extends RequestBase.AbstractBuilder<NodesStatsRequest.Builder> implements CopyableBuilder<NodesStatsRequest.Builder,NodesStatsRequest>
Builder for NodesStatsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public NodesStatsRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<NodesStatsRequest.Builder,NodesStatsRequest>
      Returns:
      a new builder instance.

    • self

      @Nonnull protected NodesStatsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<NodesStatsRequest.Builder>

    • completionFields

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

      API name: completion_fields

      Adds all elements of list to completionFields.

    • completionFields

      @Nonnull public final NodesStatsRequest.Builder completionFields(String value, String... values)
      A comma-separated list or wildcard expressions of fields to include in field data and suggest statistics.

      API name: completion_fields

      Adds one or more values to completionFields.

    • fielddataFields

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

      API name: fielddata_fields

      Adds all elements of list to fielddataFields.

    • fielddataFields

      @Nonnull public final NodesStatsRequest.Builder fielddataFields(String value, String... values)
      A comma-separated list or wildcard expressions of fields to include in field data statistics.

      API name: fielddata_fields

      Adds one or more values to fielddataFields.

    • fields

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

      API name: fields

      Adds all elements of list to fields.

    • fields

      @Nonnull public final NodesStatsRequest.Builder fields(String value, String... values)
      A comma-separated list or wildcard expressions of fields to include in the statistics.

      API name: fields

      Adds one or more values to fields.

    • groups

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

      API name: groups

      Adds all elements of list to groups.

    • groups

      @Nonnull public final NodesStatsRequest.Builder groups(String value, String... values)
      A comma-separated list of search groups to include in the search statistics.

      API name: groups

      Adds one or more values to groups.

    • includeSegmentFileSizes

      @Nonnull public final NodesStatsRequest.Builder includeSegmentFileSizes(@Nullable Boolean value)
      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 NodesStatsRequest.Builder indexMetric(List<NodesStatsIndexMetric> list)
      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

      Adds all elements of list to indexMetric.

    • indexMetric

      @Nonnull public final NodesStatsRequest.Builder indexMetric(NodesStatsIndexMetric value, NodesStatsIndexMetric... values)
      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

      Adds one or more values to indexMetric.

    • level

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

      API name: level

    • metric

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

      API name: metric

      Adds all elements of list to metric.

    • metric

      @Nonnull public final NodesStatsRequest.Builder metric(NodesStatsMetric value, NodesStatsMetric... values)
      Limit the information returned to the specified metrics.

      API name: metric

      Adds one or more values to metric.

    • nodeId

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

      API name: node_id

      Adds all elements of list to nodeId.

    • nodeId

      @Nonnull public final NodesStatsRequest.Builder nodeId(String value, String... values)
      A comma-separated list of node IDs or names used to limit returned information.

      API name: node_id

      Adds one or more values to nodeId.

    • timeout

      @Nonnull public final NodesStatsRequest.Builder timeout(@Nullable Time value)
      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

    • timeout

      @Nonnull public final NodesStatsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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 NodesStatsRequest.Builder types(List<String> list)
      A comma-separated list of document types for the indexing index metric.

      API name: types

      Adds all elements of list to types.

    • types

      @Nonnull public final NodesStatsRequest.Builder types(String value, String... values)
      A comma-separated list of document types for the indexing index metric.

      API name: types

      Adds one or more values to types.

    • build

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