java.lang.Object
org.elasticsearch.cluster.metadata.ComponentTemplate
- All Implemented Interfaces:
Diffable<ComponentTemplate>,SimpleDiffable<ComponentTemplate>,Writeable,ToXContent,ToXContentObject
public class ComponentTemplate
extends Object
implements SimpleDiffable<ComponentTemplate>, 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.cluster.SimpleDiffable
SimpleDiffable.CompleteDiff<T extends Diffable<T>>Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.cluster.SimpleDiffable
EMPTYFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionbooleaninthashCode()booleanmetadata()static ComponentTemplateparse(XContentParser parser) template()toString()toXContent(XContentBuilder builder, ToXContent.Params params) toXContent(XContentBuilder builder, ToXContent.Params params, RolloverConfiguration rolloverConfiguration) Converts the component template to XContent and passes the RolloverConditions, when provided, to the template.version()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.cluster.SimpleDiffable
diffMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
PARSER
-
-
Constructor Details
-
ComponentTemplate
-
ComponentTemplate
-
ComponentTemplate
- Throws:
IOException
-
-
Method Details
-
parse
-
template
-
version
-
metadata
-
deprecated
-
isDeprecated
public boolean isDeprecated() -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-
toString
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params, @Nullable RolloverConfiguration rolloverConfiguration) throws IOException Converts the component template to XContent and passes the RolloverConditions, when provided, to the template.- Throws:
IOException
-