Package co.elastic.clients.elasticsearch.cat

Class MasterRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.MasterRequest

public class MasterRequest
extends CatRequestBase

Get master node information.

Get information about the master node, including the ID, bound IP address, and name.

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	MasterRequest.Builder	Builder for MasterRequest.

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<MasterRequest,MasterResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.master".

Method Summary

Modifier and Type	Method	Description
final List<String>	h()	A comma-separated list of columns names to display.
final Boolean	local()	If true, the request computes the list of selected nodes from the local cluster state.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static MasterRequest	of(Function<MasterRequest.Builder,ObjectBuilder<MasterRequest>> fn)
final List<String>	s()	List of columns that determine how the table should be sorted.

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<MasterRequest,MasterResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.master".

Method Details

of

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

h

public final List<String> h()

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

API name: h

local

@Nullable
public final Boolean local()

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node.

API name: master_timeout

s

public final List<String> s()

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s