Package co.elastic.clients.elasticsearch.cat

Class AllocationRequest.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<AllocationRequest.Builder>

co.elastic.clients.elasticsearch.cat.AllocationRequest.Builder

All Implemented Interfaces:

WithJson<AllocationRequest.Builder>, ObjectBuilder<AllocationRequest>

Enclosing class:

AllocationRequest

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

Builder for AllocationRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AllocationRequest	build()	Builds a AllocationRequest.
final AllocationRequest.Builder	bytes(Bytes value)	The unit used to display byte values.
final AllocationRequest.Builder	h(String value, String... values)	List of columns to appear in the response.
final AllocationRequest.Builder	h(List<String> list)	List of columns to appear in the response.
final AllocationRequest.Builder	local(Boolean value)	If true, the request computes the list of selected nodes from the local cluster state.
final AllocationRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final AllocationRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final AllocationRequest.Builder	nodeId(String value, String... values)	A comma-separated list of node identifiers or names used to limit the returned information.
final AllocationRequest.Builder	nodeId(List<String> list)	A comma-separated list of node identifiers or names used to limit the returned information.
final AllocationRequest.Builder	s(String value, String... values)	List of columns that determine how the table should be sorted.
final AllocationRequest.Builder	s(List<String> list)	List of columns that determine how the table should be sorted.
protected AllocationRequest.Builder	self()

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 AllocationRequest.Builder bytes(@Nullable
 Bytes value)

The unit used to display byte values.

API name: bytes

h

public final AllocationRequest.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 AllocationRequest.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.

local

public final AllocationRequest.Builder local(@Nullable
 Boolean value)

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

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

Period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

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

Period to wait for a connection to the master node.

API name: master_timeout

nodeId

public final AllocationRequest.Builder nodeId(List<String> list)

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

API name: node_id

Adds all elements of list to nodeId.

nodeId

public final AllocationRequest.Builder nodeId(String value,
 String... values)

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

API name: node_id

Adds one or more values to nodeId.

s

public final AllocationRequest.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 AllocationRequest.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.

self

protected AllocationRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<AllocationRequest.Builder>

build

public AllocationRequest build()

Builds a AllocationRequest.

Specified by:

build in interface ObjectBuilder<AllocationRequest>

Throws:

NullPointerException - if some of the required fields are null.