GetIndexTemplateRequest (java-client 7.16.3 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetIndexTemplateRequest

public class GetIndexTemplateRequest
extends RequestBase

Returns an index template.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetIndexTemplateRequest.Builder
Builder for GetIndexTemplateRequest.

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<GetIndexTemplateRequest,GetIndexTemplateResponse,ErrorResponse> _ENDPOINT
Endpoint "indices.get_index_template".

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`flatSettings()`	If true, returns settings in flat format.
`java.lang.Boolean`	`includeTypeName()`	If true, a mapping type is expected in the body of mappings.
`java.lang.Boolean`	`local()`	If true, the request retrieves information from the local node only.
`Time`	`masterTimeout()`	Period to wait for a connection to the master node.
`java.lang.String`	`name()`	Comma-separated list of index template names used to limit the request.
`static GetIndexTemplateRequest`	`of(java.util.function.Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> 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<GetIndexTemplateRequest,GetIndexTemplateResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "indices.get_index_template".
Method Details
- of
  
  public static GetIndexTemplateRequest of(java.util.function.Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)
- flatSettings
  
  @Nullable public final java.lang.Boolean flatSettings()
  
  If true, returns settings in flat format.
  API name: flat_settings
- includeTypeName
  
  @Nullable public final java.lang.Boolean includeTypeName()
  
  If true, a mapping type is expected in the body of mappings.
  API name: include_type_name
- local
  
  @Nullable public final java.lang.Boolean local()
  
  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
  
  @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
  
  @Nullable public final java.lang.String name()
  
  Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.
  API name: name