Package org.opensearch.client.opensearch.nodes

Class NodesUsageRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.nodes.NodesUsageRequest.Builder

All Implemented Interfaces:

ObjectBuilder<NodesUsageRequest>

Enclosing class:

NodesUsageRequest

public static class NodesUsageRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<NodesUsageRequest>

Builder for NodesUsageRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NodesUsageRequest	build()	Builds a NodesUsageRequest.
NodesUsageRequest.Builder	metric(java.lang.String value, java.lang.String... values)	Limit the information returned to the specified metrics
NodesUsageRequest.Builder	metric(java.util.List<java.lang.String> list)	Limit the information returned to the specified metrics
NodesUsageRequest.Builder	nodeId(java.lang.String value, java.lang.String... values)	A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
NodesUsageRequest.Builder	nodeId(java.util.List<java.lang.String> list)	A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
NodesUsageRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
NodesUsageRequest.Builder	timeout(Time value)	Explicit operation timeout

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

metric

public final NodesUsageRequest.Builder metric(java.util.List<java.lang.String> list)

Limit the information returned to the specified metrics

API name: metric

Adds all elements of list to metric.

metric

public final NodesUsageRequest.Builder metric(java.lang.String value,
                                              java.lang.String... values)

Limit the information returned to the specified metrics

API name: metric

Adds one or more values to metric.

nodeId

public final NodesUsageRequest.Builder nodeId(java.util.List<java.lang.String> list)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

API name: node_id

Adds all elements of list to nodeId.

nodeId

public final NodesUsageRequest.Builder nodeId(java.lang.String value,
                                              java.lang.String... values)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

API name: node_id

Adds one or more values to nodeId.

timeout

public final NodesUsageRequest.Builder timeout(@Nullable
                                               Time value)

Explicit operation timeout

API name: timeout

timeout

public final NodesUsageRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

build

public NodesUsageRequest build()

Builds a NodesUsageRequest.

Specified by:

build in interface ObjectBuilder<NodesUsageRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.