Class GetComponentTemplatesRequest

java.lang.Object

org.opensearch.client.indices.GetComponentTemplatesRequest

All Implemented Interfaces:

Validatable

Direct Known Subclasses:

ComponentTemplatesExistRequest, ComposableIndexTemplateExistRequest

public class GetComponentTemplatesRequest
extends Object
implements Validatable

A request to read the content of component templates

Field Summary

Fields inherited from interface org.opensearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
GetComponentTemplatesRequest(String name)	Create a request to read the content of component template.

Method Summary

Modifier and Type	Method	Description
org.opensearch.common.unit.TimeValue	getClusterManagerNodeTimeout()
boolean	isLocal()
String	name()
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

GetComponentTemplatesRequest

public GetComponentTemplatesRequest(String name)

Create a request to read the content of component template. If no template name is provided, all templates will be read

Parameters:

name - the name of template to read

Method Details

name

public String name()

Returns:

the name of component template 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)