Module org.elasticsearch.server
Class ComposableIndexTemplate
java.lang.Object
org.elasticsearch.cluster.metadata.ComposableIndexTemplate
- All Implemented Interfaces:
Diffable<ComposableIndexTemplate>,SimpleDiffable<ComposableIndexTemplate>,Writeable,ToXContent,ToXContentObject
public class ComposableIndexTemplate
extends Object
implements SimpleDiffable<ComposableIndexTemplate>, ToXContentObject
An index template consists of a set of index patterns, an optional template, and a list of
ids corresponding to component templates that should be composed in order when creating a new
index.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classNested 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
FieldsModifier and TypeFieldDescriptionstatic final ConstructingObjectParser<ComposableIndexTemplate, Void> Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable
EMPTYFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuilder()booleanReturns the required component templates, i.e.inthashCode()booleanmergeSettings(Settings settings) metadata()static ComposableIndexTemplateparse(XContentParser parser) priority()longtemplate()toString()toXContent(XContentBuilder builder, ToXContent.Params params) toXContent(XContentBuilder builder, ToXContent.Params params, RolloverConfiguration rolloverConfiguration) Converts the composable index 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
-
ComposableIndexTemplate
- Throws:
IOException
-
-
Method Details
-
parse
- Throws:
IOException
-
builder
-
indexPatterns
-
template
-
composedOf
-
getRequiredComponentTemplates
Returns the required component templates, i.e. such that are not allowed to be missing, as inignoreMissingComponentTemplates.- Returns:
- a list of required component templates
-
priority
-
priorityOrZero
public long priorityOrZero() -
version
-
metadata
-
getDataStreamTemplate
-
getAllowAutoCreate
-
getIgnoreMissingComponentTemplates
-
isDeprecated
public boolean isDeprecated() -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
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 composable index template to XContent and passes the RolloverConditions, when provided, to the template.- Throws:
IOException
-
mergeSettings
-
hashCode
public int hashCode() -
equals
-
toBuilder
-
toString
-