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

Class PutIndexTemplateRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

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

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

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class PutIndexTemplateRequest
extends MasterNodeRequest<PutIndexTemplateRequest>
implements IndicesRequest

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

Field Summary

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

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
PutIndexTemplateRequest	alias(Alias alias) Adds an alias that will be added when the index gets created.
Set<Alias>	aliases()
PutIndexTemplateRequest	aliases(BytesReference source) Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequest	aliases(Map source) Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequest	aliases(String 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.
PutIndexTemplateRequest	custom(IndexMetaData.Custom custom)
Map<String,IndexMetaData.Custom>	customs()
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, Map<String,Object> source) Adds mapping that will be added when the index gets created.
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) 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)
void	readFrom(StreamInput in)
Settings	settings()
PutIndexTemplateRequest	settings(Map<String,Object> source) The settings to crete the index template with (either json/yaml/properties format).
PutIndexTemplateRequest	settings(Settings.Builder settings) The settings to create the index template with.
PutIndexTemplateRequest	settings(Settings settings) The settings to create the index template with.
PutIndexTemplateRequest	settings(String source) The settings to create the index template with (either json/yaml/properties format).
PutIndexTemplateRequest	source(byte[] source) The template source definition.
PutIndexTemplateRequest	source(byte[] source, int offset, int length) The template source definition.
PutIndexTemplateRequest	source(BytesReference source) The template source definition.
PutIndexTemplateRequest	source(Map templateSource) The template source definition.
PutIndexTemplateRequest	source(String templateSource) The template source definition.
PutIndexTemplateRequest	source(XContentBuilder templateBuilder) The template source definition.
String	template()
PutIndexTemplateRequest	template(String template)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

PutIndexTemplateRequest

public PutIndexTemplateRequest()

PutIndexTemplateRequest

public PutIndexTemplateRequest(String name)

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

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<PutIndexTemplateRequest>

name

public PutIndexTemplateRequest name(String name)

Sets the name of the index template.

name

public String name()

The name of the index template.

template

public PutIndexTemplateRequest template(String template)

template

public String template()

order

public PutIndexTemplateRequest order(int order)

order

public int order()

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

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)

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

settings

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

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

settings

public Settings settings()

mapping

public PutIndexTemplateRequest mapping(String type,
                              String source)

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

Parameters:

type - The mapping type

source - The mapping 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,
                              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 templateSource)

The template source definition.

source

public PutIndexTemplateRequest source(String templateSource)

The template source definition.

source

public PutIndexTemplateRequest source(byte[] source)

The template source definition.

source

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

The template source definition.

source

public PutIndexTemplateRequest source(BytesReference source)

The template source definition.

custom

public PutIndexTemplateRequest custom(IndexMetaData.Custom custom)

customs

public Map<String,IndexMetaData.Custom> customs()

aliases

public Set<Alias> aliases()

aliases

public PutIndexTemplateRequest aliases(Map 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

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<PutIndexTemplateRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeRequest<PutIndexTemplateRequest>

Throws:

IOException