Class ComposableIndexTemplate
java.lang.Object
org.elasticsearch.cluster.AbstractDiffable<ComposableIndexTemplate>
org.elasticsearch.cluster.metadata.ComposableIndexTemplate
- All Implemented Interfaces:
Diffable<ComposableIndexTemplate>
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class ComposableIndexTemplate extends AbstractDiffable<ComposableIndexTemplate> implements org.elasticsearch.common.xcontent.ToXContentObject
An index template is comprised 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 Classes Modifier and Type Class Description static class
ComposableIndexTemplate.Builder
static class
ComposableIndexTemplate.DataStreamTemplate
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<ComposableIndexTemplate,java.lang.Void>
PARSER
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description ComposableIndexTemplate(java.util.List<java.lang.String> indexPatterns, Template template, java.util.List<java.lang.String> componentTemplates, java.lang.Long priority, java.lang.Long version, java.util.Map<java.lang.String,java.lang.Object> metadata)
ComposableIndexTemplate(java.util.List<java.lang.String> indexPatterns, Template template, java.util.List<java.lang.String> componentTemplates, java.lang.Long priority, java.lang.Long version, java.util.Map<java.lang.String,java.lang.Object> metadata, ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate)
ComposableIndexTemplate(java.util.List<java.lang.String> indexPatterns, Template template, java.util.List<java.lang.String> componentTemplates, java.lang.Long priority, java.lang.Long version, java.util.Map<java.lang.String,java.lang.Object> metadata, ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate, java.lang.Boolean allowAutoCreate)
ComposableIndexTemplate(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.util.List<java.lang.String>
composedOf()
boolean
equals(java.lang.Object obj)
java.lang.Boolean
getAllowAutoCreate()
ComposableIndexTemplate.DataStreamTemplate
getDataStreamTemplate()
int
hashCode()
java.util.List<java.lang.String>
indexPatterns()
java.util.Map<java.lang.String,java.lang.Object>
metadata()
static ComposableIndexTemplate
parse(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.Long
priority()
long
priorityOrZero()
Template
template()
java.lang.String
toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
java.lang.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.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<ComposableIndexTemplate,java.lang.Void> PARSER
-
-
Constructor Details
-
ComposableIndexTemplate
public ComposableIndexTemplate(java.util.List<java.lang.String> indexPatterns, @Nullable Template template, @Nullable java.util.List<java.lang.String> componentTemplates, @Nullable java.lang.Long priority, @Nullable java.lang.Long version, @Nullable java.util.Map<java.lang.String,java.lang.Object> metadata) -
ComposableIndexTemplate
public ComposableIndexTemplate(java.util.List<java.lang.String> indexPatterns, @Nullable Template template, @Nullable java.util.List<java.lang.String> componentTemplates, @Nullable java.lang.Long priority, @Nullable java.lang.Long version, @Nullable java.util.Map<java.lang.String,java.lang.Object> metadata, @Nullable ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate) -
ComposableIndexTemplate
public ComposableIndexTemplate(java.util.List<java.lang.String> indexPatterns, @Nullable Template template, @Nullable java.util.List<java.lang.String> componentTemplates, @Nullable java.lang.Long priority, @Nullable java.lang.Long version, @Nullable java.util.Map<java.lang.String,java.lang.Object> metadata, @Nullable ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate, @Nullable java.lang.Boolean allowAutoCreate) -
ComposableIndexTemplate
- Throws:
java.io.IOException
-
-
Method Details
-
parse
public static ComposableIndexTemplate parse(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
indexPatterns
public java.util.List<java.lang.String> indexPatterns() -
template
-
composedOf
public java.util.List<java.lang.String> composedOf() -
priority
@Nullable public java.lang.Long priority() -
priorityOrZero
public long priorityOrZero() -
version
@Nullable public java.lang.Long version() -
metadata
@Nullable public java.util.Map<java.lang.String,java.lang.Object> metadata() -
getDataStreamTemplate
-
getAllowAutoCreate
@Nullable public java.lang.Boolean getAllowAutoCreate() -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-