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)	Return settings in flat format (default: false)
final GetTemplateRequest.Builder	includeTypeName(Boolean value)	Whether a type should be returned in the body of the mappings.
final GetTemplateRequest.Builder	local(Boolean value)	Return local information, do not retrieve the state from master node (default: false)
final GetTemplateRequest.Builder	masterTimeout(Time value)	Explicit operation timeout for connection to master node
final GetTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout for connection to master node
final GetTemplateRequest.Builder	name(String value, String... values)	The comma separated names of the index templates
final GetTemplateRequest.Builder	name(List<String> list)	The comma separated names of the index templates
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)

Return settings in flat format (default: false)

API name: flat_settings

includeTypeName

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

Whether a type should be returned in the body of the mappings.

API name: include_type_name

local

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

Return local information, do not retrieve the state from master node (default: false)

API name: local

masterTimeout

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

Explicit operation timeout for connection to master node

API name: master_timeout

masterTimeout

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

Explicit operation timeout for connection to master node

API name: master_timeout

name

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

The comma separated names of the index templates

API name: name

Adds all elements of list to name.

name

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

The comma separated names of the index templates

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.