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

Retrieves information about one or more index templates.

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 final Endpoint<GetTemplateRequest,GetTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_template".

Method Summary

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

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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(Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)

flatSettings

@Nullable
public final Boolean flatSettings()

If true, returns settings in flat format.

API name: flat_settings

local

@Nullable
public final Boolean local()

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

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

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 List<String> name()

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