java.lang.Object

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

All Implemented Interfaces:: IndicesRequest, Writeable, ToXContent, ToXContentObject, TaskAwareRequest

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.common.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.common.xcontent.ToXContent
EMPTY_PARAMS

Constructor Summary

Constructors
Constructor	Description
`PutIndexTemplateRequest()`
`PutIndexTemplateRequest(java.lang.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.
`java.util.Set<Alias>`	`aliases()`
`PutIndexTemplateRequest`	`aliases(java.lang.String source)`	Sets the aliases that will be associated with the index when it gets created
`PutIndexTemplateRequest`	`aliases(java.util.Map<java.lang.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
`java.lang.String`	`cause()`
`PutIndexTemplateRequest`	`cause(java.lang.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.
`java.lang.String[]`	`indices()`	Returns the array of indices that the action relates to
`IndicesOptions`	`indicesOptions()`	Returns the indices options used to resolve indices.
`PutIndexTemplateRequest`	`mapping(java.lang.String type, java.lang.Object... source)`	A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
`PutIndexTemplateRequest`	`mapping(java.lang.String type, java.lang.String source, XContentType xContentType)`	Adds mapping that will be added when the index gets created.
`PutIndexTemplateRequest`	`mapping(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> source)`	Adds mapping that will be added when the index gets created.
`PutIndexTemplateRequest`	`mapping(java.lang.String type, BytesReference source, XContentType xContentType)`	Adds mapping that will be added when the index gets created.
`PutIndexTemplateRequest`	`mapping(java.lang.String type, XContentBuilder source)`	Adds mapping that will be added when the index gets created.
`java.util.Map<java.lang.String,java.lang.String>`	`mappings()`
`java.lang.String`	`name()`	The name of the index template.
`PutIndexTemplateRequest`	`name(java.lang.String name)`	Sets the name of the index template.
`int`	`order()`
`PutIndexTemplateRequest`	`order(int order)`
`java.util.List<java.lang.String>`	`patterns()`
`PutIndexTemplateRequest`	`patterns(java.util.List<java.lang.String> indexPatterns)`
`Settings`	`settings()`
`PutIndexTemplateRequest`	`settings(java.lang.String source, XContentType xContentType)`	The settings to create the index template with (either json/yaml format).
`PutIndexTemplateRequest`	`settings(java.util.Map<java.lang.String,java.lang.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(java.lang.String templateSource, XContentType xContentType)`	The template source definition.
`PutIndexTemplateRequest`	`source(java.util.Map<java.lang.String,java.lang.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()`
`java.lang.Integer`	`version()`
`PutIndexTemplateRequest`	`version(java.lang.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

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

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

isFragment

Constructor Details
- PutIndexTemplateRequest
  
  public PutIndexTemplateRequest(StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- PutIndexTemplateRequest
  
  public PutIndexTemplateRequest()
- PutIndexTemplateRequest
  
  public PutIndexTemplateRequest(java.lang.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(java.lang.String name)
  
  Sets the name of the index template.
- name
  
  public java.lang.String name()
  
  The name of the index template.
- patterns
  
  public PutIndexTemplateRequest patterns(java.util.List<java.lang.String> indexPatterns)
- patterns
  
  public java.util.List<java.lang.String> patterns()
- order
  
  public PutIndexTemplateRequest order(int order)
- order
  
  public int order()
- version
  
  public PutIndexTemplateRequest version(java.lang.Integer version)
- version
  
  public java.lang.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(java.lang.String source, XContentType xContentType)
  
  The settings to create the index template with (either json/yaml format).
- settings
  
  public PutIndexTemplateRequest settings(java.util.Map<java.lang.String,java.lang.Object> source)
  
  The settings to create the index template with (either json or yaml format).
- settings
  
  public Settings settings()
- mapping
  
  public PutIndexTemplateRequest mapping(java.lang.String type, java.lang.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(java.lang.String cause)
  
  The cause for this index template creation.
- cause
  
  public java.lang.String cause()
- mapping
  
  public PutIndexTemplateRequest mapping(java.lang.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(java.lang.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(java.lang.String type, java.util.Map<java.lang.String,java.lang.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(java.lang.String type, java.lang.Object... source)
  
  A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
- mappings
  
  public java.util.Map<java.lang.String,java.lang.String> mappings()
- source
  
  public PutIndexTemplateRequest source(XContentBuilder templateBuilder)
  
  The template source definition.
- source
  
  public PutIndexTemplateRequest source(java.util.Map<java.lang.String,java.lang.Object> templateSource)
  
  The template source definition.
- source
  
  public PutIndexTemplateRequest source(java.lang.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 java.util.Set<Alias> aliases()
- aliases
  
  public PutIndexTemplateRequest aliases(java.util.Map<java.lang.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(java.lang.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 java.lang.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 java.io.IOException
  
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Overrides:
  
  writeTo in class MasterNodeRequest<PutIndexTemplateRequest>
  
  Throws:
  
  java.io.IOException
- toXContent
  
  public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
  
  Specified by:
  
  toXContent in interface ToXContent
  
  Throws:
  
  java.io.IOException

Class PutIndexTemplateRequest

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Field Summary

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

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