Package org.opensearch.client.opensearch.nodes

Class StatsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.nodes.StatsRequest
public final class StatsRequest
extends RequestBase

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  StatsRequest.Builder
    Builder for StatsRequest.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static Endpoint<StatsRequest,​StatsResponse,​OpenSearchError> ENDPOINT
    Endpoint "nodes.stats".

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected StatsRequest​(StatsRequest.Builder builder)  

  • Method Summary

    Modifier and Type Method Description
    java.util.List<java.lang.String> completionFields()
    Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
    java.util.List<java.lang.String> fielddataFields()
    Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
    java.util.List<java.lang.String> fields()
    Comma-separated list or wildcard expressions of fields to include in the statistics.
    java.lang.Boolean groups()
    Comma-separated list of search groups to include in the search statistics.
    java.lang.Boolean includeSegmentFileSizes()
    If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
    java.lang.Boolean includeUnloadedSegments()
    API name: include_unloaded_segments
    java.util.List<java.lang.String> indexMetric()
    Limit the information returned for indices metric to the specific index metrics.
    jakarta.json.JsonValue level()
    Indicates whether statistics are aggregated at the cluster, index, or shard level.
    jakarta.json.JsonValue masterTimeout()
    Period to wait for a connection to the master node.
    java.util.List<java.lang.String> metric()
    API name: metric
    java.lang.String nodeId()
    Comma-separated list of node IDs or names used to limit returned information.
    jakarta.json.JsonValue timeout()
    Period to wait for a response.
    java.util.List<java.lang.String> types()
    A comma-separated list of document types for the indexing index metric.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

  • Method Details

    • nodeId

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

    • metric

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

    • indexMetric

      @Nullable public java.util.List<java.lang.String> indexMetric()
      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

    • completionFields

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

    • fielddataFields

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

    • fields

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

    • groups

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

    • includeSegmentFileSizes

      @Nullable public java.lang.Boolean includeSegmentFileSizes()
      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

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

    • masterTimeout

      @Nullable public jakarta.json.JsonValue masterTimeout()
      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

      @Nullable public jakarta.json.JsonValue timeout()
      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

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

    • includeUnloadedSegments

      @Nullable public java.lang.Boolean includeUnloadedSegments()
      API name: include_unloaded_segments