CreateIndexRequestBuilder (Elasticsearch: Core 2.4.5 API)

java.lang.Object
- org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>
- - org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<Request,Response,RequestBuilder>
  - - org.elasticsearch.action.support.master.AcknowledgedRequestBuilder<CreateIndexRequest,CreateIndexResponse,CreateIndexRequestBuilder>
    - - org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder

public class CreateIndexRequestBuilder
extends AcknowledgedRequestBuilder<CreateIndexRequest,CreateIndexResponse,CreateIndexRequestBuilder>

Builder for a create index request

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

Constructor Summary

Constructors
Constructor and Description
`CreateIndexRequestBuilder(ElasticsearchClient client, CreateIndexAction action)`
`CreateIndexRequestBuilder(ElasticsearchClient client, CreateIndexAction action, String index)`

Method Summary

Methods
Modifier and Type	Method and Description
`CreateIndexRequestBuilder`	`addAlias(Alias alias)` Adds an alias that will be associated with the index when it gets created
`CreateIndexRequestBuilder`	`addCustom(IndexMetaData.Custom custom)` Adds custom metadata to the index to be created.
`CreateIndexRequestBuilder`	`addMapping(String type, Map<String,Object> source)` Adds mapping that will be added when the index gets created.
`CreateIndexRequestBuilder`	`addMapping(String type, Object... source)` A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
`CreateIndexRequestBuilder`	`addMapping(String type, String source)` Adds mapping that will be added when the index gets created.
`CreateIndexRequestBuilder`	`addMapping(String type, XContentBuilder source)` Adds mapping that will be added when the index gets created.
`CreateIndexRequestBuilder`	`setAliases(BytesReference source)` Sets the aliases that will be associated with the index when it gets created
`CreateIndexRequestBuilder`	`setAliases(Map source)` Sets the aliases that will be associated with the index when it gets created
`CreateIndexRequestBuilder`	`setAliases(String source)` Sets the aliases that will be associated with the index when it gets created
`CreateIndexRequestBuilder`	`setAliases(XContentBuilder source)` Sets the aliases that will be associated with the index when it gets created
`CreateIndexRequestBuilder`	`setCause(String cause)` The cause for this index creation.
`CreateIndexRequestBuilder`	`setIndex(String index)` Sets the name of the index to be created
`CreateIndexRequestBuilder`	`setSettings(Map<String,?> source)` The settings to create the index with (either json/yaml/properties format)
`CreateIndexRequestBuilder`	`setSettings(Object... settings)` A simplified version of settings that takes key value pairs settings.
`CreateIndexRequestBuilder`	`setSettings(Settings.Builder settings)` The settings to create the index with.
`CreateIndexRequestBuilder`	`setSettings(Settings settings)` The settings to create the index with.
`CreateIndexRequestBuilder`	`setSettings(String source)` The settings to create the index with (either json/yaml/properties format)
`CreateIndexRequestBuilder`	`setSettings(XContentBuilder builder)` Allows to set the settings using a json builder.
`CreateIndexRequestBuilder`	`setSource(byte[] source)` Sets the settings and mappings as a single source.
`CreateIndexRequestBuilder`	`setSource(byte[] source, int offset, int length)` Sets the settings and mappings as a single source.
`CreateIndexRequestBuilder`	`setSource(BytesReference source)` Sets the settings and mappings as a single source.
`CreateIndexRequestBuilder`	`setSource(Map<String,?> source)` Sets the settings and mappings as a single source.
`CreateIndexRequestBuilder`	`setSource(String source)` Sets the settings and mappings as a single source.
`CreateIndexRequestBuilder`	`setSource(XContentBuilder source)` Sets the settings and mappings as a single source.
`CreateIndexRequestBuilder`	`setUpdateAllTypes(boolean updateAllTypes)` True if all fields that span multiple types should be updated, false otherwise

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequestBuilder
setTimeout, setTimeout

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

CreateIndexRequestBuilder

public CreateIndexRequestBuilder(ElasticsearchClient client,
                         CreateIndexAction action)

CreateIndexRequestBuilder

public CreateIndexRequestBuilder(ElasticsearchClient client,
                         CreateIndexAction action,
                         String index)

Method Detail

setIndex

public CreateIndexRequestBuilder setIndex(String index)

Sets the name of the index to be created

setSettings

public CreateIndexRequestBuilder setSettings(Settings settings)

The settings to create the index with.

setSettings

public CreateIndexRequestBuilder setSettings(Settings.Builder settings)

The settings to create the index with.

setSettings

public CreateIndexRequestBuilder setSettings(XContentBuilder builder)

Allows to set the settings using a json builder.

setSettings
```
public CreateIndexRequestBuilder setSettings(String source)
```
The settings to create the index with (either json/yaml/properties format)

setSettings
```
public CreateIndexRequestBuilder setSettings(Object... settings)
```
A simplified version of settings that takes key value pairs settings.

setSettings
```
public CreateIndexRequestBuilder setSettings(Map<String,?> source)
```
The settings to create the index with (either json/yaml/properties format)

addMapping

public CreateIndexRequestBuilder addMapping(String type,
                                   String source)

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

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

setCause

public CreateIndexRequestBuilder setCause(String cause)

The cause for this index creation.

addMapping

public CreateIndexRequestBuilder addMapping(String type,
                                   XContentBuilder source)

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

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

addMapping

public CreateIndexRequestBuilder 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

addMapping

public CreateIndexRequestBuilder 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 CreateIndexRequestBuilder setAliases(Map source)
```
Sets the aliases that will be associated with the index when it gets created

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

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

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

addAlias
```
public CreateIndexRequestBuilder addAlias(Alias alias)
```
Adds an alias that will be associated with the index when it gets created