Package co.elastic.clients.elasticsearch.indices

Class GetIndexTemplateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.GetIndexTemplateRequest.Builder

All Implemented Interfaces:

WithJson<GetIndexTemplateRequest.Builder>, ObjectBuilder<GetIndexTemplateRequest>

Enclosing class:

GetIndexTemplateRequest

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

Builder for GetIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetIndexTemplateRequest	build()	Builds a GetIndexTemplateRequest.
final GetIndexTemplateRequest.Builder	flatSettings(Boolean value)	If true, returns settings in flat format.
final GetIndexTemplateRequest.Builder	includeDefaults(Boolean value)	If true, returns all relevant default configurations for the index template.
final GetIndexTemplateRequest.Builder	local(Boolean value)	Deprecated. 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
final GetIndexTemplateRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final GetIndexTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final GetIndexTemplateRequest.Builder	name(String value)	Name of index template to retrieve.
protected GetIndexTemplateRequest.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 GetIndexTemplateRequest.Builder flatSettings(@Nullable
 Boolean value)

If true, returns settings in flat format.

API name: flat_settings

includeDefaults

public final GetIndexTemplateRequest.Builder includeDefaults(@Nullable
 Boolean value)

If true, returns all relevant default configurations for the index template.

API name: include_defaults

local

@Deprecated
public final GetIndexTemplateRequest.Builder local(@Nullable
 Boolean value)

Deprecated.

9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

API name: local

masterTimeout

public final GetIndexTemplateRequest.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 GetIndexTemplateRequest.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 GetIndexTemplateRequest.Builder name(@Nullable
 String value)

Name of index template to retrieve. Wildcard (*) expressions are supported.

API name: name

self

protected GetIndexTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetIndexTemplateRequest.Builder>

build

public GetIndexTemplateRequest build()

Builds a GetIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<GetIndexTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.