Package org.opensearch.client.opensearch.cluster

Class StatsRequest.Builder

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

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

    ObjectBuilder.Constant<V>

  • Constructor Summary

    Constructors 
    Constructor Description
    Builder()  

  • Method Summary

    Modifier and Type Method Description
    StatsRequest build()
    Builds a StatsRequest.
    StatsRequest.Builder flatSettings​(java.lang.Boolean value)
    API name: flat_settings
    StatsRequest.Builder nodeId​(java.lang.String value)
    Comma-separated list of node filters used to limit returned information.
    StatsRequest.Builder timeout​(jakarta.json.JsonValue value)
    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

  • Constructor Details

  • Method Details

    • nodeId

      public StatsRequest.Builder nodeId​(@Nullable java.lang.String value)
      Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. API name: node_id

    • flatSettings

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

    • timeout

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

    • 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.