Package co.elastic.clients.elasticsearch.cat

Class TemplatesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.TemplatesRequest

public class TemplatesRequest
extends CatRequestBase

Get index template information.

Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<TemplatesRequest,TemplatesResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.templates".

Method Summary

Modifier and Type	Method	Description
final List<String>	h()	List of columns to appear in the response.
final Boolean	local()	If true, the request computes the list of selected nodes from the local cluster state.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final String	name()	The name of the template to return.
static TemplatesRequest	of(Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)
final List<String>	s()	List of columns that determine how the table should be sorted.

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<TemplatesRequest,TemplatesResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.templates".

Method Details

of

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

h

public final List<String> h()

List of columns to appear in the response. Supports simple wildcards.

API name: h

local

@Nullable
public final Boolean local()

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node.

API name: master_timeout

name

@Nullable
public final String name()

The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

API name: name

s

public final List<String> s()

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s