Package org.elasticsearch.cluster.metadata

Class ComposableIndexTemplate

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

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
<> indexPatterns, Template template, <> componentTemplates, priority, version, <,> metadata)
<> indexPatterns, Template template, <> componentTemplates, priority, version, <,> metadata, ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate)
<> indexPatterns, Template template, <> componentTemplates, priority, version, <,> metadata, ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate, allowAutoCreate)
ComposableIndexTemplate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
<>	composedOf()
boolean	obj)
	getAllowAutoCreate()
ComposableIndexTemplate.DataStreamTemplate	getDataStreamTemplate()
int	hashCode()
<>	indexPatterns()
<,>	metadata()
static ComposableIndexTemplate	parse(org.elasticsearch.common.xcontent.XContentParser parser)
	priority()
long	priorityOrZero()
Template	template()
	toString()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
	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.

, , , , , , ,

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<> PARSER

Constructor Details

ComposableIndexTemplate

public ComposableIndexTemplate(<> indexPatterns,
 @Nullable
 Template template,
 @Nullable
 <> componentTemplates,
 @Nullable
  priority,
 @Nullable
  version,
 @Nullable
 <,> metadata)

ComposableIndexTemplate

public ComposableIndexTemplate(<> indexPatterns,
 @Nullable
 Template template,
 @Nullable
 <> componentTemplates,
 @Nullable
  priority,
 @Nullable
  version,
 @Nullable
 <,> metadata,
 @Nullable
 ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate)

ComposableIndexTemplate

public ComposableIndexTemplate(<> indexPatterns,
 @Nullable
 Template template,
 @Nullable
 <> componentTemplates,
 @Nullable
  priority,
 @Nullable
  version,
 @Nullable
 <,> metadata,
 @Nullable
 ComposableIndexTemplate.DataStreamTemplate dataStreamTemplate,
 @Nullable
  allowAutoCreate)

ComposableIndexTemplate

public ComposableIndexTemplate(StreamInput in)
                        throws 

Throws:

Method Details

parse

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

Throws:

indexPatterns

public <> indexPatterns()

template

@Nullable
public Template template()

composedOf

public <> composedOf()

priority

@Nullable
public  priority()

priorityOrZero

public long priorityOrZero()

version

@Nullable
public  version()

metadata

@Nullable
public <,> metadata()

getDataStreamTemplate

@Nullable
public ComposableIndexTemplate.DataStreamTemplate getDataStreamTemplate()

getAllowAutoCreate

@Nullable
public  getAllowAutoCreate()

writeTo

public void writeTo(StreamOutput out)
             throws 

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

toXContent

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

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

hashCode

public int hashCode()

Overrides:

in class

equals

public boolean equals( obj)

Overrides:

in class

toString

public  toString()

Overrides:

in class