Package co.elastic.clients.elasticsearch.indices

Class GetTemplateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetTemplateRequest.Builder>

co.elastic.clients.elasticsearch.indices.GetTemplateRequest.Builder

All Implemented Interfaces:

WithJson<GetTemplateRequest.Builder>, ObjectBuilder<GetTemplateRequest>

Enclosing class:

GetTemplateRequest

public static class GetTemplateRequest.Builder
extends RequestBase.AbstractBuilder<GetTemplateRequest.Builder>
implements ObjectBuilder<GetTemplateRequest>

Builder for GetTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetTemplateRequest	build()	Builds a GetTemplateRequest.
final GetTemplateRequest.Builder	flatSettings(Boolean value)	If true, returns settings in flat format.
final GetTemplateRequest.Builder	local(Boolean value)	If true, the request retrieves information from the local node only.
final GetTemplateRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final GetTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final GetTemplateRequest.Builder	name(String value, String... values)	Comma-separated list of index template names used to limit the request.
final GetTemplateRequest.Builder	name(List<String> list)	Comma-separated list of index template names used to limit the request.
protected GetTemplateRequest.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

flatSettings

public final GetTemplateRequest.Builder flatSettings(@Nullable
 Boolean value)

If true, returns settings in flat format.

API name: flat_settings

local

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

If true, the request retrieves information from the local node only.

API name: local

masterTimeout

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

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

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

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

name

public final GetTemplateRequest.Builder name(List<String> list)

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.

API name: name

Adds all elements of list to name.

name

public final GetTemplateRequest.Builder name(String value,
 String... values)

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.

API name: name

Adds one or more values to name.

self

protected GetTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetTemplateRequest.Builder>

build

public GetTemplateRequest build()

Builds a GetTemplateRequest.

Specified by:

build in interface ObjectBuilder<GetTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.