Package org.elasticsearch.client.indices

Class PutIndexTemplateRequest

java.lang.Object
org.elasticsearch.client.TimedRequest
org.elasticsearch.client.indices.PutIndexTemplateRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public class PutIndexTemplateRequest extends TimedRequest implements org.elasticsearch.common.xcontent.ToXContentFragment
A request to create an index template.

  • Constructor Details

    • PutIndexTemplateRequest

      public PutIndexTemplateRequest​(String name, List<String> indexPatterns)
      Constructs a new put index template request with the provided name and patterns.

  • Method Details

    • name

      public PutIndexTemplateRequest name​(String name)
      Sets the name of the index template.

    • name

      public String name()
      The name of the index template.

    • patterns

      public PutIndexTemplateRequest patterns​(List<String> indexPatterns)

    • patterns

      public List<String> patterns()

    • order

      public PutIndexTemplateRequest order​(int order)

    • order

      public int order()

    • version

      public PutIndexTemplateRequest version​(Integer version)

    • version

      public Integer version()

    • create

      public PutIndexTemplateRequest create​(boolean create)
      Set to true to force only creation, not an update of an index template. If it already exists, it will fail with an IllegalArgumentException.

    • create

      public boolean create()

    • settings

      public PutIndexTemplateRequest settings​(org.elasticsearch.common.settings.Settings settings)
      The settings to create the index template with.

    • settings

      public PutIndexTemplateRequest settings​(org.elasticsearch.common.settings.Settings.Builder settings)
      The settings to create the index template with.

    • settings

      public PutIndexTemplateRequest settings​(String source, org.elasticsearch.common.xcontent.XContentType xContentType)
      The settings to create the index template with (either json/yaml format).

    • settings

      public PutIndexTemplateRequest settings​(Map<String,​Object> source)
      The settings to create the index template with (either json or yaml format).

    • settings

      public org.elasticsearch.common.settings.Settings settings()

    • mapping

      public PutIndexTemplateRequest mapping​(String source, org.elasticsearch.common.xcontent.XContentType xContentType)
      Adds mapping that will be added when the index gets created.
      Parameters:
      source - The mapping source
      xContentType - The type of content contained within the source

    • cause

      public PutIndexTemplateRequest cause​(String cause)
      The cause for this index template creation.

    • cause

      public String cause()

    • mapping

      public PutIndexTemplateRequest mapping​(org.elasticsearch.common.xcontent.XContentBuilder source)
      Adds mapping that will be added when the index gets created.
      Parameters:
      source - The mapping source

    • mapping

      public PutIndexTemplateRequest mapping​(org.elasticsearch.common.bytes.BytesReference source, org.elasticsearch.common.xcontent.XContentType xContentType)
      Adds mapping that will be added when the index gets created.
      Parameters:
      source - The mapping source
      xContentType - the source content type

    • mapping

      public PutIndexTemplateRequest mapping​(Map<String,​Object> source)
      Adds mapping that will be added when the index gets created.
      Parameters:
      source - The mapping source

    • mappings

      public org.elasticsearch.common.bytes.BytesReference mappings()

    • source

      public PutIndexTemplateRequest source​(org.elasticsearch.common.xcontent.XContentBuilder templateBuilder)
      The template source definition.

    • source

      public PutIndexTemplateRequest source​(Map<String,​Object> templateSource)
      The template source definition.

    • source

      public PutIndexTemplateRequest source​(String templateSource, org.elasticsearch.common.xcontent.XContentType xContentType)
      The template source definition.

    • source

      public PutIndexTemplateRequest source​(byte[] source, org.elasticsearch.common.xcontent.XContentType xContentType)
      The template source definition.

    • source

      public PutIndexTemplateRequest source​(byte[] source, int offset, int length, org.elasticsearch.common.xcontent.XContentType xContentType)
      The template source definition.

    • source

      public PutIndexTemplateRequest source​(org.elasticsearch.common.bytes.BytesReference source, org.elasticsearch.common.xcontent.XContentType xContentType)
      The template source definition.

    • aliases

      public Set<org.elasticsearch.action.admin.indices.alias.Alias> aliases()

    • aliases

      public PutIndexTemplateRequest aliases​(Map<String,​?> source)
      Sets the aliases that will be associated with the index when it gets created

    • aliases

      public PutIndexTemplateRequest aliases​(org.elasticsearch.common.xcontent.XContentBuilder source)
      Sets the aliases that will be associated with the index when it gets created

    • aliases

      public PutIndexTemplateRequest aliases​(String source)
      Sets the aliases that will be associated with the index when it gets created

    • aliases

      public PutIndexTemplateRequest aliases​(org.elasticsearch.common.bytes.BytesReference source)
      Sets the aliases that will be associated with the index when it gets created

    • alias

      public PutIndexTemplateRequest alias​(org.elasticsearch.action.admin.indices.alias.Alias alias)
      Adds an alias that will be added when the index gets created.
      Parameters:
      alias - The metadata for the new alias
      Returns:
      the index template creation request

    • masterNodeTimeout

      @Deprecated public final PutIndexTemplateRequest masterNodeTimeout​(org.elasticsearch.core.TimeValue timeout)
      Deprecated.
      Use TimedRequest.setMasterTimeout(TimeValue) instead

    • masterNodeTimeout

      @Deprecated public final PutIndexTemplateRequest masterNodeTimeout​(String timeout)
      Deprecated.
      Use TimedRequest.setMasterTimeout(TimeValue) instead

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException