Package org.opensearch.client.opensearch.cat

Class TemplatesRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.TemplatesRequest

All Implemented Interfaces:

ToCopyableBuilder<TemplatesRequest.Builder,TemplatesRequest>

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

Lists the names, patterns, order numbers, and version numbers of index templates.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<TemplatesRequest,TemplatesResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.templates".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static TemplatesRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time allowed to establish a connection to the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Time	masterTimeout()	Deprecated.
final String	name()	The name of the template to return.
static TemplatesRequest	of(Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)
TemplatesRequest.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.cat.CatRequestBase

headers, sort

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<TemplatesRequest,TemplatesResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.templates".

Method Details

of

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

name

@Nullable
public final String name()

The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

API name: name

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static TemplatesRequest.Builder builder()

applyQueryParameters

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

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object