Class GetIndexTemplatesRequest

java.lang.Object

org.opensearch.client.indices.GetIndexTemplatesRequest

All Implemented Interfaces:

Validatable

Direct Known Subclasses:

IndexTemplatesExistRequest

public class GetIndexTemplatesRequest
extends Object
implements Validatable

A request to read the content of index templates

Field Summary

Fields inherited from interface org.opensearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
GetIndexTemplatesRequest(String... names)	Create a request to read the content of one or more index templates.
GetIndexTemplatesRequest(List<String> names)	Create a request to read the content of one or more index templates.

Method Summary

Modifier and Type	Method	Description
org.opensearch.common.unit.TimeValue	getClusterManagerNodeTimeout()
boolean	isLocal()
List<String>	names()
void	setClusterManagerNodeTimeout(String clusterManagerNodeTimeout)
void	setClusterManagerNodeTimeout(org.opensearch.common.unit.TimeValue clusterManagerNodeTimeout)
void	setLocal(boolean local)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.Validatable

validate

Constructor Details

GetIndexTemplatesRequest

public GetIndexTemplatesRequest(String... names)

Create a request to read the content of one or more index templates. If no template names are provided, all templates will be read

Parameters:

names - the names of templates to read

GetIndexTemplatesRequest

public GetIndexTemplatesRequest(List<String> names)

Create a request to read the content of one or more index templates. If no template names are provided, all templates will be read

Parameters:

names - the names of templates to read

Method Details

names

public List<String> names()

Returns:

the names of index templates this request is requesting

getClusterManagerNodeTimeout

public org.opensearch.common.unit.TimeValue getClusterManagerNodeTimeout()

Returns:

the timeout for waiting for the cluster-manager node to respond

setClusterManagerNodeTimeout

public void setClusterManagerNodeTimeout(@Nullable
 org.opensearch.common.unit.TimeValue clusterManagerNodeTimeout)

setClusterManagerNodeTimeout

public void setClusterManagerNodeTimeout(String clusterManagerNodeTimeout)

isLocal

public boolean isLocal()

Returns:

true if this request is to read from the local cluster state, rather than the cluster-manager node - false otherwise

setLocal

public void setLocal(boolean local)