Package org.opensearch.client.opensearch.nodes

Class NodesInfoRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.nodes.NodesInfoRequest

All Implemented Interfaces:

ToCopyableBuilder<NodesInfoRequest.Builder,NodesInfoRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class NodesInfoRequest
extends RequestBase
implements ToCopyableBuilder<NodesInfoRequest.Builder,NodesInfoRequest>

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 final Endpoint<NodesInfoRequest,NodesInfoResponse,ErrorResponse>	_ENDPOINT	Endpoint "nodes.info".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static NodesInfoRequest.Builder	builder()
boolean	equals(Object o)
final Boolean	flatSettings()	When true, returns settings in flat format.
int	hashCode()
final List<NodesInfoMetric>	metric()	Limits the information returned to the specific metrics.
final List<String>	nodeId()	A comma-separated list of node IDs or names used to limit returned information.
static NodesInfoRequest	of(Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn)
final Time	timeout()	The amount of time to wait for a response.
NodesInfoRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

errorTrace, human

Methods inherited from class java.lang.Object

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

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

copy

Field Details

_ENDPOINT

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

Endpoint "nodes.info".

Method Details

of

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

flatSettings

@Nullable
public final Boolean flatSettings()

When true, returns settings in flat format.

API name: flat_settings

metric

@Nonnull
public final List<NodesInfoMetric> metric()

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

API name: metric

nodeId

@Nonnull
public final List<String> nodeId()

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

API name: node_id

timeout

@Nullable
public final Time timeout()

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

toBuilder

@Nonnull
public NodesInfoRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<NodesInfoRequest.Builder,NodesInfoRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static NodesInfoRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object