Package co.elastic.clients.elasticsearch.cat

Class NodesRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<NodesRequest.Builder>

co.elastic.clients.elasticsearch.cat.NodesRequest.Builder

All Implemented Interfaces:

WithJson<NodesRequest.Builder>, ObjectBuilder<NodesRequest>

Enclosing class:

NodesRequest

public static class NodesRequest.Builder
extends CatRequestBase.AbstractBuilder<NodesRequest.Builder>
implements ObjectBuilder<NodesRequest>

Builder for NodesRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NodesRequest	build()	Builds a NodesRequest.
final NodesRequest.Builder	bytes(Bytes value)	The unit used to display byte values.
final NodesRequest.Builder	fullId(Boolean value)	If true, return the full node ID.
final NodesRequest.Builder	h(String value, String... values)	List of columns to appear in the response.
final NodesRequest.Builder	h(List<String> list)	List of columns to appear in the response.
final NodesRequest.Builder	includeUnloadedSegments(Boolean value)	If true, the response includes information from segments that are not loaded into memory.
final NodesRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final NodesRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final NodesRequest.Builder	s(String value, String... values)	List of columns that determine how the table should be sorted.
final NodesRequest.Builder	s(List<String> list)	List of columns that determine how the table should be sorted.
protected NodesRequest.Builder	self()
final NodesRequest.Builder	time(TimeUnit value)	Unit used to display time values.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

bytes

public final NodesRequest.Builder bytes(@Nullable
 Bytes value)

The unit used to display byte values.

API name: bytes

fullId

public final NodesRequest.Builder fullId(@Nullable
 Boolean value)

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

API name: full_id

h

public final NodesRequest.Builder h(List<String> list)

List of columns to appear in the response. Supports simple wildcards.

API name: h

Adds all elements of list to h.

h

public final NodesRequest.Builder h(String value,
 String... values)

List of columns to appear in the response. Supports simple wildcards.

API name: h

Adds one or more values to h.

includeUnloadedSegments

public final NodesRequest.Builder includeUnloadedSegments(@Nullable
 Boolean value)

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

API name: include_unloaded_segments

masterTimeout

public final NodesRequest.Builder masterTimeout(@Nullable
 Time value)

Period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

public final NodesRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the master node.

API name: master_timeout

s

public final NodesRequest.Builder s(List<String> list)

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

Adds all elements of list to s.

s

public final NodesRequest.Builder s(String value,
 String... values)

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

Adds one or more values to s.

time

public final NodesRequest.Builder time(@Nullable
 TimeUnit value)

Unit used to display time values.

API name: time

self

protected NodesRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<NodesRequest.Builder>

build

public NodesRequest build()

Builds a NodesRequest.

Specified by:

build in interface ObjectBuilder<NodesRequest>

Throws:

NullPointerException - if some of the required fields are null.