Package org.elasticsearch.cluster.metadata

Class ComposableIndexTemplate

java.lang.Object

org.elasticsearch.cluster.metadata.ComposableIndexTemplate

All Implemented Interfaces:

Diffable<ComposableIndexTemplate>, SimpleDiffable<ComposableIndexTemplate>, Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class ComposableIndexTemplate
extends Object
implements SimpleDiffable<ComposableIndexTemplate>, org.elasticsearch.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.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.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 final org.elasticsearch.xcontent.ConstructingObjectParser<ComposableIndexTemplate,Void>	PARSER

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ComposableIndexTemplate(List<String> indexPatterns, Template template, List<String> componentTemplates, Long priority, Long version, Map<String,Object> metadata)
ComposableIndexTemplate(List<String> indexPatterns, Template template, List<String> componentTemplates, Long priority, Long version, Map<String,Object> metadata, ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate)
ComposableIndexTemplate(List<String> indexPatterns, Template template, List<String> componentTemplates, Long priority, Long version, Map<String,Object> metadata, ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate, Boolean allowAutoCreate)
ComposableIndexTemplate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
List<String>	composedOf()
boolean	equals(Object obj)
Boolean	getAllowAutoCreate()
ComposableIndexTemplate.DataStreamTemplate	getDataStreamTemplate()
int	hashCode()
List<String>	indexPatterns()
Map<String,Object>	metadata()
static ComposableIndexTemplate	parse(org.elasticsearch.xcontent.XContentParser parser)
Long	priority()
long	priorityOrZero()
Template	template()
String	toString()
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
Long	version()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final org.elasticsearch.xcontent.ConstructingObjectParser<ComposableIndexTemplate,Void> PARSER

Constructor Details

ComposableIndexTemplate

public ComposableIndexTemplate(List<String> indexPatterns,
 @Nullable
 Template template,
 @Nullable
 List<String> componentTemplates,
 @Nullable
 Long priority,
 @Nullable
 Long version,
 @Nullable
 Map<String,Object> metadata)

ComposableIndexTemplate

public ComposableIndexTemplate(List<String> indexPatterns,
 @Nullable
 Template template,
 @Nullable
 List<String> componentTemplates,
 @Nullable
 Long priority,
 @Nullable
 Long version,
 @Nullable
 Map<String,Object> metadata,
 @Nullable
 ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate)

ComposableIndexTemplate

public ComposableIndexTemplate(List<String> indexPatterns,
 @Nullable
 Template template,
 @Nullable
 List<String> componentTemplates,
 @Nullable
 Long priority,
 @Nullable
 Long version,
 @Nullable
 Map<String,Object> metadata,
 @Nullable
 ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate,
 @Nullable
 Boolean allowAutoCreate)

ComposableIndexTemplate

public ComposableIndexTemplate(StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

parse

public static ComposableIndexTemplate parse(org.elasticsearch.xcontent.XContentParser parser)
                                     throws IOException

Throws:

IOException

indexPatterns

public List<String> indexPatterns()

template

@Nullable
public Template template()

composedOf

public List<String> composedOf()

priority

@Nullable
public Long priority()

priorityOrZero

public long priorityOrZero()

version

@Nullable
public Long version()

metadata

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

getDataStreamTemplate

@Nullable
public ComposableIndexTemplate.DataStreamTemplate getDataStreamTemplate()

getAllowAutoCreate

@Nullable
public Boolean getAllowAutoCreate()

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

toXContent

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

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

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