Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class Template

java.lang.Object

org.elasticsearch.cluster.metadata.Template

All Implemented Interfaces:

Diffable<Template>, SimpleDiffable<Template>, Writeable, ToXContent, ToXContentObject

public class Template
extends Object
implements SimpleDiffable<Template>, ToXContentObject

A template consists of optional settings, mappings, alias or lifecycle configuration for an index or data stream, however, it is entirely independent of an index or data stream. It's a building block forming part of a regular index template and a ComponentTemplate.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Template.Builder

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 DataStreamLifecycle.Template	DISABLED_LIFECYCLE
static final ConstructingObjectParser<Template,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
Template(StreamInput in)
Template(Settings settings, CompressedXContent mappings, Map<String,AliasMetadata> aliases)
Template(Settings settings, CompressedXContent mappings, Map<String,AliasMetadata> aliases, DataStreamLifecycle.Template lifecycle, DataStreamOptions.Template dataStreamOptions)
Template(Settings settings, CompressedXContent mappings, Map<String,AliasMetadata> aliases, DataStreamLifecycle.Template lifecycle, ResettableValue<DataStreamOptions.Template> dataStreamOptions)

Method Summary

Modifier and Type	Method	Description
Map<String,AliasMetadata>	aliases()
static Template.Builder	builder()
static Template.Builder	builder(Template template)
DataStreamOptions.Template	dataStreamOptions()
boolean	equals(Object obj)
int	hashCode()
DataStreamLifecycle.Template	lifecycle()
CompressedXContent	mappings()
ResettableValue<DataStreamOptions.Template>	resettableDataStreamOptions()
Settings	settings()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params, RolloverConfiguration rolloverConfiguration)	Converts the template to XContent and passes the RolloverConditions, when provided, to the lifecycle.
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<Template,Void> PARSER

DISABLED_LIFECYCLE

public static final DataStreamLifecycle.Template DISABLED_LIFECYCLE

Constructor Details

Template

public Template(@Nullable
 Settings settings,
 @Nullable
 CompressedXContent mappings,
 @Nullable
 Map<String,AliasMetadata> aliases,
 @Nullable
 DataStreamLifecycle.Template lifecycle,
 ResettableValue<DataStreamOptions.Template> dataStreamOptions)

Template

public Template(@Nullable
 Settings settings,
 @Nullable
 CompressedXContent mappings,
 @Nullable
 Map<String,AliasMetadata> aliases,
 @Nullable
 DataStreamLifecycle.Template lifecycle,
 @Nullable
 DataStreamOptions.Template dataStreamOptions)

Template

public Template(@Nullable
 Settings settings,
 @Nullable
 CompressedXContent mappings,
 @Nullable
 Map<String,AliasMetadata> aliases)

Template

public Template(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

settings

@Nullable
public Settings settings()

mappings

@Nullable
public CompressedXContent mappings()

aliases

@Nullable
public Map<String,AliasMetadata> aliases()

lifecycle

@Nullable
public DataStreamLifecycle.Template lifecycle()

dataStreamOptions

@Nullable
public DataStreamOptions.Template dataStreamOptions()

resettableDataStreamOptions

public ResettableValue<DataStreamOptions.Template> resettableDataStreamOptions()

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

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

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 template to XContent and passes the RolloverConditions, when provided, to the lifecycle. Depending on the set by ResettableValue.hideResetValues(Params) it may or may not display null when the value is to be reset.

Throws:

IOException

builder

public static Template.Builder builder()

builder

public static Template.Builder builder(@Nullable
 Template template)