Package co.elastic.clients.elasticsearch.cat

Class NodesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.NodesRequest

public class NodesRequest
extends CatRequestBase

Get node information.

Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<NodesRequest,NodesResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.nodes".

Method Summary

Modifier and Type	Method	Description
final Bytes	bytes()	The unit used to display byte values.
final Boolean	fullId()	If true, return the full node ID.
final List<String>	h()	A comma-separated list of columns names to display.
final Boolean	includeUnloadedSegments()	If true, the response includes information from segments that are not loaded into memory.
final Time	masterTimeout()	The period to wait for a connection to the master node.
static NodesRequest	of(Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)
final List<String>	s()	A comma-separated list of column names or aliases that determines the sort order.
final TimeUnit	time()	The unit used to display time values.

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<NodesRequest,NodesResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.nodes".

Method Details

of

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

bytes

@Nullable
public final Bytes bytes()

The unit used to display byte values.

API name: bytes

fullId

@Nullable
public final Boolean fullId()

If true, return the full node ID. If false, return the shortened node ID.

API name: full_id

h

public final List<String> h()

A comma-separated list of columns names to display. It supports simple wildcards.

API name: h

includeUnloadedSegments

@Nullable
public final Boolean includeUnloadedSegments()

If true, the response includes information from segments that are not loaded into memory.

API name: include_unloaded_segments

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for a connection to the master node.

API name: master_timeout

s

public final List<String> s()

A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s

time

@Nullable
public final TimeUnit time()

The unit used to display time values.

API name: time