Package org.opensearch.client.opensearch.cluster

Class StatsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.cluster.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 "cluster.stats".

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    java.lang.Boolean flatSettings()
    API name: flat_settings
    java.lang.String nodeId()
    Comma-separated list of node filters used to limit returned information.
    jakarta.json.JsonValue timeout()
    Period to wait for each node to respond.

    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 filters used to limit returned information. Defaults to all nodes in the cluster. API name: node_id

    • flatSettings

      @Nullable public java.lang.Boolean flatSettings()
      API name: flat_settings

    • timeout

      @Nullable public jakarta.json.JsonValue timeout()
      Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's _nodes.failed property. Defaults to no timeout. API name: timeout