Package org.elasticsearch.cluster.metadata

Class ComponentTemplate

java.lang.Object

org.elasticsearch.cluster.AbstractDiffable<ComponentTemplate>

org.elasticsearch.cluster.metadata.ComponentTemplate

All Implemented Interfaces:

Diffable<ComponentTemplate>, Writeable, ToXContent, ToXContentObject

public class ComponentTemplate
extends AbstractDiffable<ComponentTemplate>
implements 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.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 final ConstructingObjectParser<ComponentTemplate,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ComponentTemplate(Template template, Long version, Map<String,Object> metadata)
ComponentTemplate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
Map<String,Object>	metadata()
static ComponentTemplate	parse(XContentParser parser)
Template	template()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Long	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.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final ConstructingObjectParser<ComponentTemplate,Void> PARSER

Constructor Details

ComponentTemplate

public ComponentTemplate(Template template,
 @Nullable
 Long version,
 @Nullable
 Map<String,Object> metadata)

ComponentTemplate

public ComponentTemplate(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

parse

public static ComponentTemplate parse(XContentParser parser)

template

public Template template()

version

@Nullable
public Long version()

metadata

@Nullable
public Map<String,Object> metadata()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException