Package org.elasticsearch.cluster.metadata

Class Template

org.elasticsearch.cluster.AbstractDiffable<Template>
org.elasticsearch.cluster.metadata.Template
All Implemented Interfaces:
Diffable<Template>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class Template extends AbstractDiffable<Template> implements org.elasticsearch.common.xcontent.ToXContentObject
A template consists of optional settings, mappings, or alias configuration for an index, however, it is entirely independent from an index. It's a building block forming part of a regular index template and a ComponentTemplate.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<>
    PARSER
     

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    Template​(StreamInput in)
     
    Template​(Settings settings, CompressedXContent mappings, <,​AliasMetadata> aliases)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    <,​AliasMetadata>
    aliases()
     
    boolean
     obj)
     
    int
    hashCode()
     
    CompressedXContent
    mappings()
     
    Settings
    settings()
     
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    void
    writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

    diff, readDiffFrom

    Methods inherited from class java.lang.

    , , , , , , ,

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

  • Field Details

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<> PARSER

  • Constructor Details

  • Method Details

    • settings

      @Nullable public Settings settings()

    • mappings

      @Nullable public CompressedXContent mappings()

    • aliases

      @Nullable public <,​AliasMetadata> aliases()

    • writeTo

      public void writeTo​(StreamOutput out) throws
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:

    • hashCode

      public int hashCode()
      Overrides:
       in class 

    • equals

      public boolean equals​( obj)
      Overrides:
       in class 

    • toString

      public  toString()
      Overrides:
       in class 

    • toXContent

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