Package org.opensearch.client.opensearch.indices

Class GetIndexTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetIndexTemplateRequest

All Implemented Interfaces:

ToCopyableBuilder<GetIndexTemplateRequest.Builder,GetIndexTemplateRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetIndexTemplateRequest
extends RequestBase
implements ToCopyableBuilder<GetIndexTemplateRequest.Builder,GetIndexTemplateRequest>

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

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetIndexTemplateRequest.Builder	builder()
final Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
boolean	equals(Object o)
final Boolean	flatSettings()	If true, returns settings in flat format.
int	hashCode()
final Boolean	local()	If true, the request retrieves information from the local node only.
final Time	masterTimeout()	Deprecated.
final String	name()	Name of the index template to retrieve.
static GetIndexTemplateRequest	of(Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)
GetIndexTemplateRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

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

Endpoint "indices.get_index_template".

Method Details

of

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

flatSettings

@Nullable
public final Boolean flatSettings()

If true, returns settings in flat format.

API name: flat_settings

local

@Nullable
public final 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 cluster-manager 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 String name()

Name of the index template to retrieve. Wildcard (*) expressions are supported.

API name: name

toBuilder

@Nonnull
public GetIndexTemplateRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetIndexTemplateRequest.Builder,GetIndexTemplateRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetIndexTemplateRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object