Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.create

Class CreateIndexRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response>

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

All Implemented Interfaces:

RequestBuilder<CreateIndexRequest,CreateIndexResponse>

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	Description
CreateIndexRequestBuilder(ElasticsearchClient client)
CreateIndexRequestBuilder(ElasticsearchClient client, String index)

Method Summary

Modifier and Type	Method	Description
CreateIndexRequestBuilder	addAlias(Alias alias)	Adds an alias 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(Map<String,?> source)	Sets the aliases that will be associated with the index when it gets created
CreateIndexRequestBuilder	setAliases(BytesReference 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	setMapping(String source)	Adds mapping that will be added when the index gets created.
CreateIndexRequestBuilder	setMapping(String... source)	A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
CreateIndexRequestBuilder	setMapping(Map<String,Object> source)	Adds mapping that will be added when the index gets created.
CreateIndexRequestBuilder	setMapping(XContentBuilder source)	Adds mapping that will be added when the index gets created.
CreateIndexRequestBuilder	setRequireDataStream(boolean requireDataStream)	Set whether this request requires a data stream.
CreateIndexRequestBuilder	setSettings(String source, XContentType xContentType)	The settings to create the index with (either json or yaml format)
CreateIndexRequestBuilder	setSettings(Map<String,?> source)	The settings to create the index with (either json/yaml/properties format)
CreateIndexRequestBuilder	setSettings(Settings settings)	The settings to create the index with.
CreateIndexRequestBuilder	setSettings(Settings.Builder settings)	The settings to create the index with.
CreateIndexRequestBuilder	setSettings(XContentBuilder builder)	Allows to set the settings using a json builder.
CreateIndexRequestBuilder	setSource(byte[] source, int offset, int length, XContentType xContentType)	Sets the settings and mappings as a single source.
CreateIndexRequestBuilder	setSource(byte[] source, XContentType xContentType)	Sets the settings and mappings as a single source.
CreateIndexRequestBuilder	setSource(String source, XContentType xContentType)	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(BytesReference source, XContentType xContentType)	Sets the settings and mappings as a single source.
CreateIndexRequestBuilder	setSource(XContentBuilder source)	Sets the settings and mappings as a single source.
CreateIndexRequestBuilder	setWaitForActiveShards(int waitForActiveShards)	A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
CreateIndexRequestBuilder	setWaitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that should be active for index creation to return.

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

execute, execute, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

CreateIndexRequestBuilder

public CreateIndexRequestBuilder(ElasticsearchClient client)

CreateIndexRequestBuilder

public CreateIndexRequestBuilder(ElasticsearchClient client,
 String index)

Method Details

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,
 XContentType xContentType)

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

setSettings

public CreateIndexRequestBuilder setSettings(Map<String,?> source)

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

setMapping

public CreateIndexRequestBuilder setMapping(String source)

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

Parameters:

source - The mapping source

setCause

public CreateIndexRequestBuilder setCause(String cause)

The cause for this index creation.

setMapping

public CreateIndexRequestBuilder setMapping(XContentBuilder source)

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

Parameters:

source - The mapping source

setMapping

public CreateIndexRequestBuilder setMapping(Map<String,Object> source)

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

Parameters:

source - The mapping source

setMapping

public CreateIndexRequestBuilder setMapping(String... source)

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

setAliases

public CreateIndexRequestBuilder setAliases(Map<String,?> 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

setSource

public CreateIndexRequestBuilder setSource(String source,
 XContentType xContentType)

Sets the settings and mappings as a single source.

setSource

public CreateIndexRequestBuilder setSource(BytesReference source,
 XContentType xContentType)

Sets the settings and mappings as a single source.

setSource

public CreateIndexRequestBuilder setSource(byte[] source,
 XContentType xContentType)

Sets the settings and mappings as a single source.

setSource

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

Sets the settings and mappings as a single source.

setSource

public CreateIndexRequestBuilder setSource(Map<String,?> source)

Sets the settings and mappings as a single source.

setSource

public CreateIndexRequestBuilder setSource(XContentBuilder source)

Sets the settings and mappings as a single source.

setWaitForActiveShards

public CreateIndexRequestBuilder setWaitForActiveShards(ActiveShardCount waitForActiveShards)

Sets the number of shard copies that should be active for index creation to return. Defaults to ActiveShardCount.DEFAULT, which will wait for one shard copy (the primary) to become active. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active before returning. Otherwise, use ActiveShardCount.from(int) to set this value to any non-negative integer, up to the number of copies per shard (number of replicas + 1), to wait for the desired amount of shard copies to become active before returning. Index creation will only wait up until the timeout value for the number of shard copies to be active before returning. Check ShardsAcknowledgedResponse.isShardsAcknowledged() to determine if the requisite shard copies were all started before returning or timing out.

Parameters:

waitForActiveShards - number of active shard copies to wait on

setWaitForActiveShards

public CreateIndexRequestBuilder setWaitForActiveShards(int waitForActiveShards)

A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.

setRequireDataStream

public CreateIndexRequestBuilder setRequireDataStream(boolean requireDataStream)

Set whether this request requires a data stream. The data stream may be pre-existing or to-be-created.