Package co.elastic.clients.elasticsearch.indices

Class GetTemplateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetTemplateRequest

public class GetTemplateRequest
extends RequestBase

Returns an index template.

See Also:

API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetTemplateRequest.Builder	Builder for GetTemplateRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<GetTemplateRequest,GetTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_template".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	flatSettings()	Return settings in flat format (default: false)
java.lang.Boolean	includeTypeName()	Whether a type should be returned in the body of the mappings.
java.lang.Boolean	local()	Return local information, do not retrieve the state from master node (default: false)
Time	masterTimeout()	Explicit operation timeout for connection to master node
java.util.List<java.lang.String>	name()	The comma separated names of the index templates
static GetTemplateRequest	of(java.util.function.Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<GetTemplateRequest,GetTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_template".

Method Details

of

public static GetTemplateRequest of(java.util.function.Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)

flatSettings

@Nullable
public final java.lang.Boolean flatSettings()

Return settings in flat format (default: false)

API name: flat_settings

includeTypeName

@Nullable
public final java.lang.Boolean includeTypeName()

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

API name: include_type_name

local

@Nullable
public final java.lang.Boolean local()

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

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

Explicit operation timeout for connection to master node

API name: master_timeout

name

public final java.util.List<java.lang.String> name()

The comma separated names of the index templates

API name: name