Package co.elastic.clients.elasticsearch.indices

Class ExistsTemplateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ExistsTemplateRequest

public class ExistsTemplateRequest
extends RequestBase

Check existence of index templates. Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<ExistsTemplateRequest,BooleanResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.exists_template".

Method Summary

Modifier and Type	Method	Description
final Boolean	flatSettings()	Indicates whether to use a flat format for the response.
final Boolean	local()	Indicates whether to get information from the local node only.
final Time	masterTimeout()	The period to wait for the master node.
final List<String>	name()	Required - A comma-separated list of index template names used to limit the request.
static ExistsTemplateRequest	of(Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> 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<ExistsTemplateRequest,BooleanResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.exists_template".

Method Details

of

public static ExistsTemplateRequest of(Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)

flatSettings

@Nullable
public final Boolean flatSettings()

Indicates whether to use a flat format for the response.

API name: flat_settings

local

@Nullable
public final Boolean local()

Indicates whether to get information from the local node only.

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

name

public final List<String> name()

Required - A comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

API name: name