Package org.elasticsearch.client.indices

Class GetIndexTemplatesRequest

java.lang.Object
org.elasticsearch.client.indices.GetIndexTemplatesRequest
All Implemented Interfaces:
Validatable
Direct Known Subclasses:
IndexTemplatesExistRequest
public class GetIndexTemplatesRequest
extends java.lang.Object
implements Validatable
A request to read the content of index templates

  • Field Summary

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    org.elasticsearch.common.unit.TimeValue getMasterNodeTimeout()  
    boolean isLocal()  
    java.util.List<java.lang.String> names()  
    void setLocal​(boolean local)  
    void setMasterNodeTimeout​(java.lang.String masterNodeTimeout)  
    void setMasterNodeTimeout​(org.elasticsearch.common.unit.TimeValue masterNodeTimeout)  

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Constructor Details

    • GetIndexTemplatesRequest

      public GetIndexTemplatesRequest​(java.lang.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​(java.util.List<java.lang.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 java.util.List<java.lang.String> names()
      Returns:
      the names of index templates this request is requesting

    • getMasterNodeTimeout

      public org.elasticsearch.common.unit.TimeValue getMasterNodeTimeout()
      Returns:
      the timeout for waiting for the master node to respond

    • setMasterNodeTimeout

      public void setMasterNodeTimeout​(@Nullable org.elasticsearch.common.unit.TimeValue masterNodeTimeout)

    • setMasterNodeTimeout

      public void setMasterNodeTimeout​(java.lang.String masterNodeTimeout)

    • isLocal

      public boolean isLocal()
      Returns:
      true if this request is to read from the local cluster state, rather than the master node - false otherwise

    • setLocal

      public void setLocal​(boolean local)