Package co.elastic.clients.elasticsearch.cat

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

co.elastic.clients.elasticsearch.cat.TemplatesRequest.Builder

All Implemented Interfaces:

WithJson<TemplatesRequest.Builder>, ObjectBuilder<TemplatesRequest>

Enclosing class:

TemplatesRequest

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

Builder for TemplatesRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TemplatesRequest	build()	Builds a TemplatesRequest.
final TemplatesRequest.Builder	local(Boolean value)	If true, the request computes the list of selected nodes from the local cluster state.
final TemplatesRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final TemplatesRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final TemplatesRequest.Builder	name(String value)	The name of the template to return.
protected TemplatesRequest.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

local

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

Period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

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

Period to wait for a connection to the master node.

API name: master_timeout

name

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

The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

API name: name

self

protected TemplatesRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<TemplatesRequest.Builder>

build

public TemplatesRequest build()

Builds a TemplatesRequest.

Specified by:

build in interface ObjectBuilder<TemplatesRequest>

Throws:

NullPointerException - if some of the required fields are null.