Package org.opensearch.cluster.metadata
Class ComposableIndexTemplate
java.lang.Object
org.opensearch.cluster.AbstractDiffable<ComposableIndexTemplate>
org.opensearch.cluster.metadata.ComposableIndexTemplate
- All Implemented Interfaces:
Diffable<ComposableIndexTemplate>
,Writeable
,org.opensearch.common.xcontent.ToXContent
,org.opensearch.common.xcontent.ToXContentObject
public class ComposableIndexTemplate extends AbstractDiffable<ComposableIndexTemplate> implements org.opensearch.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.DataStreamTemplate
Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static org.opensearch.common.xcontent.ConstructingObjectParser<ComposableIndexTemplate,java.lang.Void>
PARSER
-
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(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.util.List<java.lang.String>
composedOf()
boolean
equals(java.lang.Object obj)
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.opensearch.common.xcontent.XContentParser parser)
java.lang.Long
priority()
long
priorityOrZero()
Template
template()
java.lang.String
toString()
org.opensearch.common.xcontent.XContentBuilder
toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
java.lang.Long
version()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
PARSER
public static final org.opensearch.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
- Throws:
java.io.IOException
-
-
Method Details
-
parse
public static ComposableIndexTemplate parse(org.opensearch.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
public java.lang.Long priority() -
priorityOrZero
public long priorityOrZero() -
version
public java.lang.Long version() -
metadata
public java.util.Map<java.lang.String,java.lang.Object> metadata() -
getDataStreamTemplate
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.opensearch.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
-