Package org.elasticsearch.cluster.metadata

Class ComponentTemplate

org.elasticsearch.cluster.AbstractDiffable<ComponentTemplate>
org.elasticsearch.cluster.metadata.ComponentTemplate
All Implemented Interfaces:
Diffable<ComponentTemplate>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class ComponentTemplate extends AbstractDiffable<ComponentTemplate> implements org.elasticsearch.common.xcontent.ToXContentObject
A component template is a re-usable Template as well as metadata about the template. Each component template is expected to be valid on its own. For example, if a component template contains a field "foo", it's expected to contain all the necessary settings/mappings/etc for the "foo" field. These component templates make up the individual pieces composing an index template.

  • 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
    ComponentTemplate​(Template template,  version, <,​> metadata)
     
    ComponentTemplate​(StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     obj)
     
    int
    hashCode()
     
    <,​>
    metadata()
     
    static ComponentTemplate
    parse​(org.elasticsearch.common.xcontent.XContentParser parser)
     
    Template
    template()
     
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    version()
     
    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

    • ComponentTemplate

      public ComponentTemplate​(Template template, @Nullable  version, @Nullable <,​> metadata)

    • ComponentTemplate

      public ComponentTemplate​(StreamInput in) throws
      Throws:

  • Method Details

    • parse

      public static ComponentTemplate parse​(org.elasticsearch.common.xcontent.XContentParser parser)

    • template

      public Template template()

    • version

      @Nullable public  version()

    • metadata

      @Nullable public <,​> metadata()

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