Package org.opensearch.client.indices

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

  • 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

    • getMasterNodeTimeout

      @Deprecated public org.opensearch.common.unit.TimeValue getMasterNodeTimeout()
      Deprecated.
      As of 2.2, because supporting inclusive language, replaced by getMasterNodeTimeout()
      Returns:
      the timeout for waiting for the cluster-manager node to respond

    • setClusterManagerNodeTimeout

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

    • setMasterNodeTimeout

      @Deprecated public void setMasterNodeTimeout(@Nullable org.opensearch.common.unit.TimeValue clusterManagerNodeTimeout)
      Deprecated.
      As of 2.2, because supporting inclusive language, replaced by setClusterManagerNodeTimeout(TimeValue)

    • setClusterManagerNodeTimeout

      public void setClusterManagerNodeTimeout(String clusterManagerNodeTimeout)

    • setMasterNodeTimeout

      @Deprecated public void setMasterNodeTimeout(String clusterManagerNodeTimeout)
      Deprecated.
      As of 2.2, because supporting inclusive language, replaced by setClusterManagerNodeTimeout(String)

    • 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)