Package org.opensearch.client.opensearch.nodes

Class StatsRequest.Builder

java.lang.Object
org.opensearch.client.opensearch.nodes.StatsRequest.Builder
All Implemented Interfaces:
ObjectBuilder<StatsRequest>
Enclosing class:
StatsRequest
public static class StatsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<StatsRequest>
Builder for StatsRequest.

  • Constructor Details

  • Method Details

    • nodeId

      public StatsRequest.Builder nodeId​(@Nullable java.lang.String value)
      Comma-separated list of node IDs or names used to limit returned information. API name: node_id

    • metric

      public StatsRequest.Builder metric​(@Nullable java.util.List<java.lang.String> value)
      API name: metric

    • metric

      public StatsRequest.Builder metric​(java.lang.String... value)
      API name: metric

    • addMetric

      public StatsRequest.Builder addMetric​(java.lang.String value)
      Add a value to metric(List), creating the list if needed.

    • indexMetric

      public StatsRequest.Builder indexMetric​(@Nullable java.util.List<java.lang.String> value)
      Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. API name: index_metric

    • indexMetric

      public StatsRequest.Builder indexMetric​(java.lang.String... value)
      Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. API name: index_metric

    • addIndexMetric

      public StatsRequest.Builder addIndexMetric​(java.lang.String value)
      Add a value to indexMetric(List), creating the list if needed.

    • completionFields

      public StatsRequest.Builder completionFields​(@Nullable java.util.List<java.lang.String> value)
      Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. API name: completion_fields

    • completionFields

      public StatsRequest.Builder completionFields​(java.lang.String... value)
      Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. API name: completion_fields

    • addCompletionFields

      public StatsRequest.Builder addCompletionFields​(java.lang.String value)
      Add a value to completionFields(List), creating the list if needed.

    • fielddataFields

      public StatsRequest.Builder fielddataFields​(@Nullable java.util.List<java.lang.String> value)
      Comma-separated list or wildcard expressions of fields to include in fielddata statistics. API name: fielddata_fields

    • fielddataFields

      public StatsRequest.Builder fielddataFields​(java.lang.String... value)
      Comma-separated list or wildcard expressions of fields to include in fielddata statistics. API name: fielddata_fields

    • addFielddataFields

      public StatsRequest.Builder addFielddataFields​(java.lang.String value)
      Add a value to fielddataFields(List), creating the list if needed.

    • fields

      public StatsRequest.Builder fields​(@Nullable java.util.List<java.lang.String> value)
      Comma-separated list or wildcard expressions of fields to include in the statistics. API name: fields

    • fields

      public StatsRequest.Builder fields​(java.lang.String... value)
      Comma-separated list or wildcard expressions of fields to include in the statistics. API name: fields

    • addFields

      public StatsRequest.Builder addFields​(java.lang.String value)
      Add a value to fields(List), creating the list if needed.

    • groups

      public StatsRequest.Builder groups​(@Nullable java.lang.Boolean value)
      Comma-separated list of search groups to include in the search statistics. API name: groups

    • includeSegmentFileSizes

      public StatsRequest.Builder includeSegmentFileSizes​(@Nullable java.lang.Boolean value)
      If true, the call 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

    • level

      public StatsRequest.Builder level​(@Nullable jakarta.json.JsonValue value)
      Indicates whether statistics are aggregated at the cluster, index, or shard level. API name: level

    • masterTimeout

      public StatsRequest.Builder masterTimeout​(@Nullable jakarta.json.JsonValue value)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

    • timeout

      public StatsRequest.Builder timeout​(@Nullable jakarta.json.JsonValue value)
      Period 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

      public StatsRequest.Builder types​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of document types for the indexing index metric. API name: types

    • types

      public StatsRequest.Builder types​(java.lang.String... value)
      A comma-separated list of document types for the indexing index metric. API name: types

    • addTypes

      public StatsRequest.Builder addTypes​(java.lang.String value)
      Add a value to types(List), creating the list if needed.

    • includeUnloadedSegments

      public StatsRequest.Builder includeUnloadedSegments​(@Nullable java.lang.Boolean value)
      API name: include_unloaded_segments

    • build

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