GetTemplateRequest (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.indices.GetTemplateRequest

public class GetTemplateRequest
extends RequestBase

Returns an index template.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GetTemplateRequest.Builder
Builder for GetTemplateRequest.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
  RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type Field Description

static Endpoint<GetTemplateRequest,GetTemplateResponse,ErrorResponse> _ENDPOINT
Endpoint "indices.get_template".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Time`	`clusterManagerTimeout()`	Explicit operation timeout for connection to cluster-manager node
`java.lang.Boolean`	`flatSettings()`	Return settings in flat format (default: false)
`java.lang.Boolean`	`local()`	Return local information, do not retrieve the state from cluster-manager node (default: false)
`Time`	`masterTimeout()`	Deprecated.
`java.util.List<java.lang.String>`	`name()`	The comma separated names of the index templates
`static GetTemplateRequest`	`of(java.util.function.Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _ENDPOINT
```
public static final Endpoint<GetTemplateRequest,GetTemplateResponse,ErrorResponse> _ENDPOINT
```
    Endpoint "indices.get_template".
- Method Detail
  - of
```
public static GetTemplateRequest of(java.util.function.Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)
```
  - flatSettings
```
@Nullable
public final java.lang.Boolean flatSettings()
```
    Return settings in flat format (default: false)
    API name: flat_settings
  - local
```
@Nullable
public final java.lang.Boolean local()
```
    Return local information, do not retrieve the state from cluster-manager node (default: false)
    API name: local
  - masterTimeout
```
@Deprecated
@Nullable
public final Time masterTimeout()
```
    Deprecated.
    
    Explicit operation timeout for connection to master node
    API name: master_timeout
  - clusterManagerTimeout
```
@Nullable
public final Time clusterManagerTimeout()
```
    Explicit operation timeout for connection to cluster-manager node
    API name: cluster_manager_timeout
  - name
```
public final java.util.List<java.lang.String> name()
```
    The comma separated names of the index templates
    API name: name