Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

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 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

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

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ComposableIndexTemplate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static ComposableIndexTemplate.Builder	builder()
List<String>	composedOf()
boolean	equals(Object obj)
Boolean	getAllowAutoCreate()
ComposableIndexTemplate.DataStreamTemplate	getDataStreamTemplate()
List<String>	getIgnoreMissingComponentTemplates()
List<String>	getRequiredComponentTemplates()	Returns the required component templates, i.e.
int	hashCode()
List<String>	indexPatterns()
boolean	isDeprecated()
Map<String,Object>	metadata()
static ComposableIndexTemplate	parse(XContentParser parser)
Long	priority()
long	priorityOrZero()
Template	template()
ComposableIndexTemplate.Builder	toBuilder()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params, RolloverConfiguration rolloverConfiguration)	Converts the composable index template to XContent and passes the RolloverConditions, when provided, to the template.
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 ConstructingObjectParser<ComposableIndexTemplate,Void> PARSER

Constructor Details

ComposableIndexTemplate

public ComposableIndexTemplate(StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

parse

public static ComposableIndexTemplate parse(XContentParser parser)
                                     throws IOException

Throws:

IOException

builder

public static ComposableIndexTemplate.Builder builder()

indexPatterns

public List<String> indexPatterns()

template

@Nullable
public Template template()

composedOf

public List<String> composedOf()

getRequiredComponentTemplates

public List<String> getRequiredComponentTemplates()

Returns the required component templates, i.e. such that are not allowed to be missing, as in ignoreMissingComponentTemplates.

Returns:

a list of required component templates

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()

getIgnoreMissingComponentTemplates

@Nullable
public List<String> getIgnoreMissingComponentTemplates()

isDeprecated

public boolean isDeprecated()

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 XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toBuilder

public ComposableIndexTemplate.Builder toBuilder()

toString

public String toString()

Overrides:

toString in class Object