Package co.elastic.clients.elasticsearch.cluster

Class ClusterStatsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.cluster.ClusterStatsRequest.Builder
All Implemented Interfaces:
ObjectBuilder<ClusterStatsRequest>
Enclosing class:
ClusterStatsRequest
public static class ClusterStatsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<ClusterStatsRequest>
Builder for ClusterStatsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • flatSettings

      public final ClusterStatsRequest.Builder flatSettings​(@Nullable java.lang.Boolean value)
      Return settings in flat format (default: false)

      API name: flat_settings

    • nodeId

      public final ClusterStatsRequest.Builder nodeId​(java.util.List<java.lang.String> list)
      Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.

      API name: node_id

      Adds all elements of list to nodeId.

    • nodeId

      public final ClusterStatsRequest.Builder nodeId​(java.lang.String value, java.lang.String... values)
      Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.

      API name: node_id

      Adds one or more values to nodeId.

    • timeout

      public final ClusterStatsRequest.Builder timeout​(@Nullable Time 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

    • timeout

      public final ClusterStatsRequest.Builder timeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      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 ClusterStatsRequest build()
      Builds a ClusterStatsRequest.
      Specified by:
      build in interface ObjectBuilder<ClusterStatsRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.