Package org.opensearch.client.opensearch.indices

Class GetIndexTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetIndexTemplateRequest

public class GetIndexTemplateRequest
extends RequestBase

Returns an index template.

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Period to wait for a connection to the cluster-manager node.
java.lang.Boolean	flatSettings()	If true, returns settings in flat format.
java.lang.Boolean	local()	If true, the request retrieves information from the local node only.
Time	masterTimeout()	Deprecated.
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 Detail

_ENDPOINT

public static final Endpoint<GetIndexTemplateRequest,GetIndexTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_index_template".

Method Detail

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

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 cluster-manager node.

API name: local

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_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