Package org.opensearch.client.opensearch.nodes

Class NodesInfoRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.nodes.NodesInfoRequest

public class NodesInfoRequest
extends RequestBase

Returns information about nodes in the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodesInfoRequest.Builder	Builder for NodesInfoRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<NodesInfoRequest,NodesInfoResponse,ErrorResponse>	_ENDPOINT	Endpoint "nodes.info".

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<NodesInfoRequest,NodesInfoResponse,ErrorResponse> _ENDPOINT

Endpoint "nodes.info".

Method Detail

of

public static NodesInfoRequest of(java.util.function.Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn)

flatSettings

@Nullable
public final java.lang.Boolean flatSettings()

If true, returns settings in flat format.

API name: flat_settings

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

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

@Nullable
public final Time clusterManagerTimeout()

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 java.util.List<java.lang.String> metric()

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

API name: metric

nodeId

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

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

API name: node_id

timeout

@Nullable
public final Time timeout()

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