Package org.opensearch.client.opensearch.nodes

Class NodesUsageRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<NodesUsageRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<NodesUsageRequest.Builder,NodesUsageRequest>, MutableBuilder<NodesUsageRequest.Builder,NodesUsageRequest>, ObjectBuilder<NodesUsageRequest>

Enclosing class:

NodesUsageRequest

public static class NodesUsageRequest.Builder
extends RequestBase.AbstractBuilder<NodesUsageRequest.Builder>
implements CopyableBuilder<NodesUsageRequest.Builder,NodesUsageRequest>

Builder for NodesUsageRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NodesUsageRequest	build()	Builds a NodesUsageRequest.
NodesUsageRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NodesUsageRequest.Builder	metric(List<NodesUsageMetric> list)	Limits the information returned to the specific metrics.
final NodesUsageRequest.Builder	metric(NodesUsageMetric value, NodesUsageMetric... values)	Limits the information returned to the specific metrics.
final NodesUsageRequest.Builder	nodeId(String value, 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
final NodesUsageRequest.Builder	nodeId(List<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
protected NodesUsageRequest.Builder	self()
final NodesUsageRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final NodesUsageRequest.Builder	timeout(Time value)	Period to wait for a response.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public NodesUsageRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<NodesUsageRequest.Builder,NodesUsageRequest>

Returns:

a new builder instance.

self

@Nonnull
protected NodesUsageRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<NodesUsageRequest.Builder>

metric

@Nonnull
public final NodesUsageRequest.Builder metric(List<NodesUsageMetric> list)

Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

API name: metric

Adds all elements of list to metric.

metric

@Nonnull
public final NodesUsageRequest.Builder metric(NodesUsageMetric value,
 NodesUsageMetric... values)

Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

API name: metric

Adds one or more values to metric.

nodeId

@Nonnull
public final NodesUsageRequest.Builder nodeId(List<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

@Nonnull
public final NodesUsageRequest.Builder nodeId(String value,
 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

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

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

timeout

@Nonnull
public final NodesUsageRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

build

@Nonnull
public NodesUsageRequest build()

Builds a NodesUsageRequest.

Specified by:

build in interface ObjectBuilder<NodesUsageRequest>

Throws:

NullPointerException - if some of the required fields are null.