Package org.elasticsearch.action.admin.indices.template.put

Class PutIndexTemplateRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<PutIndexTemplateRequest>

org.elasticsearch.action.admin.indices.template.put.PutIndexTemplateRequest

All Implemented Interfaces:

IndicesRequest, Writeable, RefCounted, TaskAwareRequest, ToXContent, ToXContentObject

public class PutIndexTemplateRequest
extends MasterNodeRequest<PutIndexTemplateRequest>
implements IndicesRequest, ToXContentObject

A request to create an index template.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

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 inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PutIndexTemplateRequest()
PutIndexTemplateRequest(String name)	Constructs a new put index template request with the provided name.
PutIndexTemplateRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
PutIndexTemplateRequest	alias(Alias alias)	Adds an alias that will be added when the index gets created.
Set<Alias>	aliases()
PutIndexTemplateRequest	aliases(String source)	Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequest	aliases(Map<String,?> source)	Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequest	aliases(BytesReference source)	Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequest	aliases(XContentBuilder source)	Sets the aliases that will be associated with the index when it gets created
String	cause()
PutIndexTemplateRequest	cause(String cause)	The cause for this index template creation.
boolean	create()
PutIndexTemplateRequest	create(boolean create)	Set to true to force only creation, not an update of an index template.
String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
PutIndexTemplateRequest	mapping(String type, Object... source)	A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
PutIndexTemplateRequest	mapping(String type, String source, XContentType xContentType)	Adds mapping that will be added when the index gets created.
PutIndexTemplateRequest	mapping(String type, Map<String,Object> source)	Adds mapping that will be added when the index gets created.
PutIndexTemplateRequest	mapping(String type, BytesReference source, XContentType xContentType)	Adds mapping that will be added when the index gets created.
PutIndexTemplateRequest	mapping(String type, XContentBuilder source)	Adds mapping that will be added when the index gets created.
Map<String,String>	mappings()
String	name()	The name of the index template.
PutIndexTemplateRequest	name(String name)	Sets the name of the index template.
int	order()
PutIndexTemplateRequest	order(int order)
List<String>	patterns()
PutIndexTemplateRequest	patterns(List<String> indexPatterns)
Settings	settings()
PutIndexTemplateRequest	settings(String source, XContentType xContentType)	The settings to create the index template with (either json/yaml format).
PutIndexTemplateRequest	settings(Map<String,Object> source)	The settings to create the index template with (either json or yaml format).
PutIndexTemplateRequest	settings(Settings settings)	The settings to create the index template with.
PutIndexTemplateRequest	settings(Settings.Builder settings)	The settings to create the index template with.
PutIndexTemplateRequest	source(byte[] source, int offset, int length, XContentType xContentType)	The template source definition.
PutIndexTemplateRequest	source(byte[] source, XContentType xContentType)	The template source definition.
PutIndexTemplateRequest	source(String templateSource, XContentType xContentType)	The template source definition.
PutIndexTemplateRequest	source(Map<String,Object> templateSource)	The template source definition.
PutIndexTemplateRequest	source(BytesReference source, XContentType xContentType)	The template source definition.
PutIndexTemplateRequest	source(XContentBuilder templateBuilder)	The template source definition.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
Integer	version()
PutIndexTemplateRequest	version(Integer version)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

PutIndexTemplateRequest

public PutIndexTemplateRequest(StreamInput in)
                        throws IOException

Throws:

IOException

PutIndexTemplateRequest

public PutIndexTemplateRequest()

PutIndexTemplateRequest

public PutIndexTemplateRequest(String name)

Constructs a new put index template request with the provided name.

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

name

public PutIndexTemplateRequest name(String name)

Sets the name of the index template.

name

public String name()

The name of the index template.

patterns

public PutIndexTemplateRequest patterns(List<String> indexPatterns)

patterns

public List<String> patterns()

order

public PutIndexTemplateRequest order(int order)

order

public int order()

version

public PutIndexTemplateRequest version(Integer version)

version

public Integer version()

create

public PutIndexTemplateRequest create(boolean create)

Set to true to force only creation, not an update of an index template. If it already exists, it will fail with an IllegalArgumentException.

create

public boolean create()

settings

public PutIndexTemplateRequest settings(Settings settings)

The settings to create the index template with.

settings

public PutIndexTemplateRequest settings(Settings.Builder settings)

The settings to create the index template with.

settings

public PutIndexTemplateRequest settings(String source,
 XContentType xContentType)

The settings to create the index template with (either json/yaml format).

settings

public PutIndexTemplateRequest settings(Map<String,Object> source)

The settings to create the index template with (either json or yaml format).

settings

public Settings settings()

mapping

public PutIndexTemplateRequest mapping(String type,
 String source,
 XContentType xContentType)

Adds mapping that will be added when the index gets created.

Parameters:

type - The mapping type

source - The mapping source

xContentType - The type of content contained within the source

cause

public PutIndexTemplateRequest cause(String cause)

The cause for this index template creation.

cause

public String cause()

mapping

public PutIndexTemplateRequest mapping(String type,
 XContentBuilder source)

Adds mapping that will be added when the index gets created.

Parameters:

type - The mapping type

source - The mapping source

mapping

public PutIndexTemplateRequest mapping(String type,
 BytesReference source,
 XContentType xContentType)

Adds mapping that will be added when the index gets created.

Parameters:

type - The mapping type

source - The mapping source

xContentType - the source content type

mapping

public PutIndexTemplateRequest mapping(String type,
 Map<String,Object> source)

Adds mapping that will be added when the index gets created.

Parameters:

type - The mapping type

source - The mapping source

mapping

public PutIndexTemplateRequest mapping(String type,
 Object... source)

A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").

mappings

public Map<String,String> mappings()

source

public PutIndexTemplateRequest source(XContentBuilder templateBuilder)

The template source definition.

source

public PutIndexTemplateRequest source(Map<String,Object> templateSource)

The template source definition.

source

public PutIndexTemplateRequest source(String templateSource,
 XContentType xContentType)

The template source definition.

source

public PutIndexTemplateRequest source(byte[] source,
 XContentType xContentType)

The template source definition.

source

public PutIndexTemplateRequest source(byte[] source,
 int offset,
 int length,
 XContentType xContentType)

The template source definition.

source

public PutIndexTemplateRequest source(BytesReference source,
 XContentType xContentType)

The template source definition.

aliases

public Set<Alias> aliases()

aliases

public PutIndexTemplateRequest aliases(Map<String,?> source)

Sets the aliases that will be associated with the index when it gets created

aliases

public PutIndexTemplateRequest aliases(XContentBuilder source)

Sets the aliases that will be associated with the index when it gets created

aliases

public PutIndexTemplateRequest aliases(String source)

Sets the aliases that will be associated with the index when it gets created

aliases

public PutIndexTemplateRequest aliases(BytesReference source)

Sets the aliases that will be associated with the index when it gets created

alias

public PutIndexTemplateRequest alias(Alias alias)

Adds an alias that will be added when the index gets created.

Parameters:

alias - The metadata for the new alias

Returns:

the index template creation request

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeRequest<PutIndexTemplateRequest>

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException