Package org.opensearch.client.opensearch.nodes

Class NodesInfoRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.nodes.NodesInfoRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

NodesInfoRequest

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

Builder for NodesInfoRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NodesInfoRequest	build()	Builds a NodesInfoRequest.
NodesInfoRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NodesInfoRequest.Builder	flatSettings(Boolean value)	When true, returns settings in flat format.
final NodesInfoRequest.Builder	metric(List<NodesInfoMetric> list)	Limits the information returned to the specific metrics.
final NodesInfoRequest.Builder	metric(NodesInfoMetric value, NodesInfoMetric... values)	Limits the information returned to the specific metrics.
final NodesInfoRequest.Builder	nodeId(String value, String... values)	A comma-separated list of node IDs or names used to limit returned information.
final NodesInfoRequest.Builder	nodeId(List<String> list)	A comma-separated list of node IDs or names used to limit returned information.
protected NodesInfoRequest.Builder	self()
final NodesInfoRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response.
final NodesInfoRequest.Builder	timeout(Time value)	The amount of time 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 NodesInfoRequest.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<NodesInfoRequest.Builder,NodesInfoRequest>

Returns:

a new builder instance.

self

@Nonnull
protected NodesInfoRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<NodesInfoRequest.Builder>

flatSettings

@Nonnull
public final NodesInfoRequest.Builder flatSettings(@Nullable
 Boolean value)

When true, returns settings in flat format.

API name: flat_settings

metric

@Nonnull
public final NodesInfoRequest.Builder metric(List<NodesInfoMetric> list)

Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

API name: metric

Adds all elements of list to metric.

metric

@Nonnull
public final NodesInfoRequest.Builder metric(NodesInfoMetric value,
 NodesInfoMetric... values)

Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

API name: metric

Adds one or more values to metric.

nodeId

@Nonnull
public final NodesInfoRequest.Builder nodeId(List<String> list)

A comma-separated list of node IDs or names used to limit returned information.

API name: node_id

Adds all elements of list to nodeId.

nodeId

@Nonnull
public final NodesInfoRequest.Builder nodeId(String value,
 String... values)

A comma-separated list of node IDs or names used to limit returned information.

API name: node_id

Adds one or more values to nodeId.

timeout

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

The amount of time 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 NodesInfoRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time 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 NodesInfoRequest build()

Builds a NodesInfoRequest.

Specified by:

build in interface ObjectBuilder<NodesInfoRequest>

Throws:

NullPointerException - if some of the required fields are null.