Package org.opensearch.client.opensearch.nodes

Class NodesInfoRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<NodesInfoRequest>

Enclosing class:

NodesInfoRequest

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

Builder for NodesInfoRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NodesInfoRequest	build()	Builds a NodesInfoRequest.
NodesInfoRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the cluster-manager node.
NodesInfoRequest.Builder	clusterManagerTimeout(Time value)	Period to wait for a connection to the cluster-manager node.
NodesInfoRequest.Builder	flatSettings(java.lang.Boolean value)	If true, returns settings in flat format.
NodesInfoRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
NodesInfoRequest.Builder	masterTimeout(Time value)	Deprecated.
NodesInfoRequest.Builder	metric(java.lang.String value, java.lang.String... values)	Limits the information returned to the specific metrics.
NodesInfoRequest.Builder	metric(java.util.List<java.lang.String> list)	Limits the information returned to the specific metrics.
NodesInfoRequest.Builder	nodeId(java.lang.String value, java.lang.String... values)	Comma-separated list of node IDs or names used to limit returned information.
NodesInfoRequest.Builder	nodeId(java.util.List<java.lang.String> list)	Comma-separated list of node IDs or names used to limit returned information.
NodesInfoRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
NodesInfoRequest.Builder	timeout(Time value)	Period to wait for a response.

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

flatSettings

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

If true, returns settings in flat format.

API name: flat_settings

masterTimeout

@Deprecated
public final NodesInfoRequest.Builder masterTimeout(@Nullable
                                                    Time value)

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

@Deprecated
public final NodesInfoRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

clusterManagerTimeout

public final NodesInfoRequest.Builder clusterManagerTimeout(@Nullable
                                                            Time value)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

metric

public final NodesInfoRequest.Builder metric(java.util.List<java.lang.String> 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

public final NodesInfoRequest.Builder metric(java.lang.String value,
                                             java.lang.String... 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

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

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

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

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

public final NodesInfoRequest.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

public final NodesInfoRequest.Builder timeout(java.util.function.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

public NodesInfoRequest build()

Builds a NodesInfoRequest.

Specified by:

build in interface ObjectBuilder<NodesInfoRequest>

Throws:

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