PutIndexTemplateRequestBuilder (Elasticsearch: Core 2.4.6 API)

java.lang.Object
- org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>
- - org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<PutIndexTemplateRequest,PutIndexTemplateResponse,PutIndexTemplateRequestBuilder>
  - - org.elasticsearch.action.admin.indices.template.put.PutIndexTemplateRequestBuilder

public class PutIndexTemplateRequestBuilder
extends MasterNodeOperationRequestBuilder<PutIndexTemplateRequest,PutIndexTemplateResponse,PutIndexTemplateRequestBuilder>

Field Summary
- Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
  action, client, request

Constructor Summary

Constructors
Constructor and Description
`PutIndexTemplateRequestBuilder(ElasticsearchClient client, PutIndexTemplateAction action)`
`PutIndexTemplateRequestBuilder(ElasticsearchClient client, PutIndexTemplateAction action, String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`PutIndexTemplateRequestBuilder`	`addAlias(Alias alias)` Adds an alias that will be added when the index template gets created.
`PutIndexTemplateRequestBuilder`	`addMapping(String type, Map<String,Object> source)` Adds mapping that will be added when the index gets created.
`PutIndexTemplateRequestBuilder`	`addMapping(String type, Object... source)` A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
`PutIndexTemplateRequestBuilder`	`addMapping(String type, String source)` Adds mapping that will be added when the index template gets created.
`PutIndexTemplateRequestBuilder`	`addMapping(String type, XContentBuilder source)` Adds mapping that will be added when the index template gets created.
`PutIndexTemplateRequestBuilder`	`cause(String cause)` The cause for this index template creation.
`PutIndexTemplateRequestBuilder`	`setAliases(BytesReference source)` Sets the aliases that will be associated with the index when it gets created
`PutIndexTemplateRequestBuilder`	`setAliases(Map source)` Sets the aliases that will be associated with the index when it gets created
`PutIndexTemplateRequestBuilder`	`setAliases(String source)` Sets the aliases that will be associated with the index when it gets created
`PutIndexTemplateRequestBuilder`	`setAliases(XContentBuilder source)` Sets the aliases that will be associated with the index when it gets created
`PutIndexTemplateRequestBuilder`	`setCreate(boolean create)` Set to `true` to force only creation, not an update of an index template.
`PutIndexTemplateRequestBuilder`	`setOrder(int order)` Sets the order of this template if more than one template matches.
`PutIndexTemplateRequestBuilder`	`setSettings(Map<String,Object> source)` The settings to crete the index template with (either json/yaml/properties format)
`PutIndexTemplateRequestBuilder`	`setSettings(Settings.Builder settings)` The settings to created the index template with.
`PutIndexTemplateRequestBuilder`	`setSettings(Settings settings)` The settings to created the index template with.
`PutIndexTemplateRequestBuilder`	`setSettings(String source)` The settings to crete the index template with (either json/yaml/properties format)
`PutIndexTemplateRequestBuilder`	`setSource(byte[] templateSource)` The template source definition.
`PutIndexTemplateRequestBuilder`	`setSource(byte[] templateSource, int offset, int length)` The template source definition.
`PutIndexTemplateRequestBuilder`	`setSource(BytesReference templateSource)` The template source definition.
`PutIndexTemplateRequestBuilder`	`setSource(Map templateSource)` The template source definition.
`PutIndexTemplateRequestBuilder`	`setSource(String templateSource)` The template source definition.
`PutIndexTemplateRequestBuilder`	`setSource(XContentBuilder templateBuilder)` The template source definition.
`PutIndexTemplateRequestBuilder`	`setTemplate(String template)` Sets the template match expression that will be used to match on indices created.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder
setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder
beforeExecute, execute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PutIndexTemplateRequestBuilder

public PutIndexTemplateRequestBuilder(ElasticsearchClient client,
                              PutIndexTemplateAction action)

PutIndexTemplateRequestBuilder

public PutIndexTemplateRequestBuilder(ElasticsearchClient client,
                              PutIndexTemplateAction action,
                              String name)

Method Detail

setTemplate
```
public PutIndexTemplateRequestBuilder setTemplate(String template)
```
Sets the template match expression that will be used to match on indices created.

setOrder
```
public PutIndexTemplateRequestBuilder setOrder(int order)
```
Sets the order of this template if more than one template matches.

setCreate
```
public PutIndexTemplateRequestBuilder setCreate(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.

setSettings

public PutIndexTemplateRequestBuilder setSettings(Settings settings)

The settings to created the index template with.

setSettings

public PutIndexTemplateRequestBuilder setSettings(Settings.Builder settings)

The settings to created the index template with.

setSettings
```
public PutIndexTemplateRequestBuilder setSettings(String source)
```
The settings to crete the index template with (either json/yaml/properties format)

setSettings
```
public PutIndexTemplateRequestBuilder setSettings(Map<String,Object> source)
```
The settings to crete the index template with (either json/yaml/properties format)

addMapping

public PutIndexTemplateRequestBuilder addMapping(String type,
                                        String source)

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

Parameters:: type - The mapping type; source - The mapping source

addMapping

public PutIndexTemplateRequestBuilder addMapping(String type,
                                        Object... source)

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

setAliases
```
public PutIndexTemplateRequestBuilder setAliases(Map source)
```
Sets the aliases that will be associated with the index when it gets created

setAliases
```
public PutIndexTemplateRequestBuilder setAliases(String source)
```
Sets the aliases that will be associated with the index when it gets created

setAliases
```
public PutIndexTemplateRequestBuilder setAliases(XContentBuilder source)
```
Sets the aliases that will be associated with the index when it gets created

setAliases
```
public PutIndexTemplateRequestBuilder setAliases(BytesReference source)
```
Sets the aliases that will be associated with the index when it gets created

addAlias
```
public PutIndexTemplateRequestBuilder addAlias(Alias alias)
```
Adds an alias that will be added when the index template gets created.

Parameters:
alias - The alias

Returns:
the request builder

cause

public PutIndexTemplateRequestBuilder cause(String cause)

The cause for this index template creation.

addMapping

public PutIndexTemplateRequestBuilder addMapping(String type,
                                        XContentBuilder source)

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

Parameters:: type - The mapping type; source - The mapping source

addMapping

public PutIndexTemplateRequestBuilder addMapping(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