Package org.opensearch.client.opensearch.indices

Class ExistsIndexTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.ExistsIndexTemplateRequest

All Implemented Interfaces:

ToCopyableBuilder<ExistsIndexTemplateRequest.Builder,ExistsIndexTemplateRequest>

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

Returns information about whether a particular index template exists.

Nested Class Summary

Nested Classes

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

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<ExistsIndexTemplateRequest,BooleanResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.exists_index_template".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static ExistsIndexTemplateRequest.Builder	builder()
final Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
boolean	equals(Object o)
final Boolean	flatSettings()	Return settings in flat format.
int	hashCode()
final Boolean	local()	Return local information, do not retrieve the state from cluster-manager node.
final Time	masterTimeout()	Deprecated.
final String	name()	Required - Name of the index template to check existence of.
static ExistsIndexTemplateRequest	of(Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)
ExistsIndexTemplateRequest.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<ExistsIndexTemplateRequest,BooleanResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.exists_index_template".

Method Details

of

public static ExistsIndexTemplateRequest of(Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> 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()

Return settings in flat format.

API name: flat_settings

local

@Nullable
public final Boolean local()

Return local information, do not retrieve the state from 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

@Nonnull
public final String name()

Required - Name of the index template to check existence of. Wildcard (*) expressions are supported.

API name: name

toBuilder

@Nonnull
public ExistsIndexTemplateRequest.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<ExistsIndexTemplateRequest.Builder,ExistsIndexTemplateRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ExistsIndexTemplateRequest.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