Package co.elastic.clients.elasticsearch.nodes

Class NodesInfoRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.nodes.NodesInfoRequest

public class NodesInfoRequest
extends RequestBase

Get node information.

By default, the API returns all attributes and core settings for cluster nodes.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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
final Boolean	flatSettings()	If true, returns settings in flat format.
final List<String>	metric()	Limits the information returned to the specific metrics.
final List<String>	nodeId()	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()	Period to wait for a response.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

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()

If true, returns settings in flat format.

API name: flat_settings

metric

public final List<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 List<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