Package co.elastic.clients.elasticsearch.cat

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

co.elastic.clients.elasticsearch.cat.PluginsRequest.Builder

All Implemented Interfaces:

WithJson<PluginsRequest.Builder>, ObjectBuilder<PluginsRequest>

Enclosing class:

PluginsRequest

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

Builder for PluginsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PluginsRequest	build()	Builds a PluginsRequest.
final PluginsRequest.Builder	h(CatPluginsColumn value, CatPluginsColumn... values)	A comma-separated list of columns names to display.
final PluginsRequest.Builder	h(String value, String... values)	A comma-separated list of columns names to display.
final PluginsRequest.Builder	h(List<String> list)	A comma-separated list of columns names to display.
final PluginsRequest.Builder	includeBootstrap(Boolean value)	Include bootstrap plugins in the response
final PluginsRequest.Builder	local(Boolean value)	If true, the request computes the list of selected nodes from the local cluster state.
final PluginsRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final PluginsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final PluginsRequest.Builder	s(String value, String... values)	List of columns that determine how the table should be sorted.
final PluginsRequest.Builder	s(List<String> list)	List of columns that determine how the table should be sorted.
protected PluginsRequest.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

h

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

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

API name: h

Adds all elements of list to h.

h

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

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

API name: h

Adds one or more values to h.

h

public final PluginsRequest.Builder h(CatPluginsColumn value,
 CatPluginsColumn... values)

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

API name: h

Adds one or more enum values to h.

includeBootstrap

public final PluginsRequest.Builder includeBootstrap(@Nullable
 Boolean value)

Include bootstrap plugins in the response

API name: include_bootstrap

local

public final PluginsRequest.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 PluginsRequest.Builder masterTimeout(@Nullable
 Time value)

Period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

public final PluginsRequest.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 PluginsRequest.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 PluginsRequest.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 PluginsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<PluginsRequest.Builder>

build

public PluginsRequest build()

Builds a PluginsRequest.

Specified by:

build in interface ObjectBuilder<PluginsRequest>

Throws:

NullPointerException - if some of the required fields are null.