Package co.elastic.clients.elasticsearch.cat

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

co.elastic.clients.elasticsearch.cat.ComponentTemplatesRequest.Builder

All Implemented Interfaces:

WithJson<ComponentTemplatesRequest.Builder>, ObjectBuilder<ComponentTemplatesRequest>

Enclosing class:

ComponentTemplatesRequest

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

Builder for ComponentTemplatesRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

local

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

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

API name: master_timeout

masterTimeout

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

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

API name: master_timeout

name

public final ComponentTemplatesRequest.Builder name(@Nullable
 String value)

The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.

API name: name

s

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

Specified by:

self in class CatRequestBase.AbstractBuilder<ComponentTemplatesRequest.Builder>

build

public ComponentTemplatesRequest build()

Builds a ComponentTemplatesRequest.

Specified by:

build in interface ObjectBuilder<ComponentTemplatesRequest>

Throws:

NullPointerException - if some of the required fields are null.