GetTemplateRequest (java-client 7.15.0 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetTemplateRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class GetTemplateRequest
extends RequestBase

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,ElasticsearchError> ENDPOINT
Endpoint "indices.get_template".

Constructor Summary

Constructors
Constructor	Description
`GetTemplateRequest(GetTemplateRequest.Builder builder)`
`GetTemplateRequest(java.util.function.Function<GetTemplateRequest.Builder,GetTemplateRequest.Builder> fn)`

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)
`java.lang.String`	`masterTimeout()`	Explicit operation timeout for connection to master node
`java.util.List<java.lang.String>`	`name()`	The comma separated names of the index templates

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,ElasticsearchError> ENDPOINT
  
  Endpoint "indices.get_template".
Constructor Details
- GetTemplateRequest
  
  public GetTemplateRequest(GetTemplateRequest.Builder builder)
- GetTemplateRequest
  
  public GetTemplateRequest(java.util.function.Function<GetTemplateRequest.Builder,GetTemplateRequest.Builder> fn)
Method Details
- name
  
  @Nullable public java.util.List<java.lang.String> name()
  
  The comma separated names of the index templates
  API name: name
- flatSettings
  
  @Nullable public java.lang.Boolean flatSettings()
  
  Return settings in flat format (default: false)
  API name: flat_settings
- includeTypeName
  
  @Nullable public java.lang.Boolean includeTypeName()
  
  Whether a type should be returned in the body of the mappings.
  API name: include_type_name
- local
  
  @Nullable public java.lang.Boolean local()
  
  Return local information, do not retrieve the state from master node (default: false)
  API name: local
- masterTimeout
  
  @Nullable public java.lang.String masterTimeout()
  
  Explicit operation timeout for connection to master node
  API name: master_timeout