Module org.elasticsearch.server

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

Class CreateIndexRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

org.elasticsearch.action.support.master.AcknowledgedRequest<CreateIndexRequest>

org.elasticsearch.action.admin.indices.create.CreateIndexRequest

All Implemented Interfaces:

IndicesRequest, AckedRequest, Writeable, RefCounted, TaskAwareRequest

public class CreateIndexRequest
extends AcknowledgedRequest<CreateIndexRequest>
implements IndicesRequest

A request to create an index.

The index created can optionally be created with settings(org.elasticsearch.common.settings.Settings).

See Also:

• IndicesAdminClient.create(CreateIndexRequest)
• CreateIndexResponse

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.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	ALIASES
static final ParseField	MAPPINGS
static final ParseField	SETTINGS

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

DEFAULT_ACK_TIMEOUT, timeout

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

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
CreateIndexRequest()
CreateIndexRequest(String index)	Constructs a request to create an index.
CreateIndexRequest(String index, Settings settings)	Constructs a request to create an index.
CreateIndexRequest(StreamInput in)	Constructs a new request by deserializing an input

Method Summary

Modifier and Type	Method	Description
CreateIndexRequest	alias(Alias alias)	Adds an alias that will be associated with the index when it gets created
Set<Alias>	aliases()
CreateIndexRequest	aliases(String source)	Sets the aliases that will be associated with the index when it gets created
CreateIndexRequest	aliases(Map<String,?> source)	Sets the aliases that will be associated with the index when it gets created
CreateIndexRequest	aliases(BytesReference source)	Sets the aliases that will be associated with the index when it gets created
CreateIndexRequest	aliases(XContentBuilder source)	Sets the aliases that will be associated with the index when it gets created
String	cause()	The cause for this index creation.
CreateIndexRequest	cause(String cause)	The cause for this index creation.
boolean	equals(Object obj)
int	hashCode()
String	index()	The index name to create.
CreateIndexRequest	index(String index)
String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
CreateIndexRequest	mapping(String mapping)	Set the mapping for this index The mapping should be in the form of a JSON string, with an outer _doc key
CreateIndexRequest	mapping(Map<String,?> source)	Set the mapping for this index
CreateIndexRequest	mapping(XContentBuilder source)	Set the mapping for this index
String	mappings()
String	origin()
CreateIndexRequest	origin(String origin)
Settings	settings()	The settings to create the index with.
CreateIndexRequest	settings(String source, XContentType xContentType)	The settings to create the index with (either json or yaml format)
CreateIndexRequest	settings(Map<String,?> source)	The settings to create the index with (either json/yaml/properties format)
CreateIndexRequest	settings(Settings settings)	The settings to create the index with.
CreateIndexRequest	settings(Settings.Builder settings)	The settings to create the index with.
CreateIndexRequest	settings(XContentBuilder builder)	Allows to set the settings using a json builder.
CreateIndexRequest	simpleMapping(String... source)	A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
CreateIndexRequest	source(byte[] source, int offset, int length, XContentType xContentType)	Sets the settings and mappings as a single source.
CreateIndexRequest	source(byte[] source, XContentType xContentType)	Sets the settings and mappings as a single source.
CreateIndexRequest	source(String source, XContentType xContentType)	Sets the settings and mappings as a single source.
CreateIndexRequest	source(Map<String,?> source, DeprecationHandler deprecationHandler)	Sets the settings and mappings as a single source.
CreateIndexRequest	source(BytesReference source, XContentType xContentType)	Sets the settings and mappings as a single source.
CreateIndexRequest	source(XContentBuilder source)	Sets the settings and mappings as a single source.
ActionRequestValidationException	validate()
ActiveShardCount	waitForActiveShards()
CreateIndexRequest	waitForActiveShards(int waitForActiveShards)	A shortcut for waitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
CreateIndexRequest	waitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that should be active for index creation to return.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

ackTimeout, timeout, timeout, timeout

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, getRequestId, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

MAPPINGS

public static final ParseField MAPPINGS

SETTINGS

public static final ParseField SETTINGS

ALIASES

public static final ParseField ALIASES

Constructor Details

CreateIndexRequest

public CreateIndexRequest(StreamInput in)
                   throws IOException

Constructs a new request by deserializing an input

Parameters:

in - the input from which to deserialize

Throws:

IOException

CreateIndexRequest

public CreateIndexRequest()

CreateIndexRequest

public CreateIndexRequest(String index)

Constructs a request to create an index.

Parameters:

index - the name of the index

CreateIndexRequest

public CreateIndexRequest(String index,
 Settings settings)

Constructs a request to create an index.

Parameters:

index - the name of the index

settings - the settings to apply to the index

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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

index

public String index()

The index name to create.

index

public CreateIndexRequest index(String index)

settings

public Settings settings()

The settings to create the index with.

cause

public String cause()

The cause for this index creation.

origin

public String origin()

origin

public CreateIndexRequest origin(String origin)

settings

public CreateIndexRequest settings(Settings.Builder settings)

The settings to create the index with.

settings

public CreateIndexRequest settings(Settings settings)

The settings to create the index with.

settings

public CreateIndexRequest settings(String source,
 XContentType xContentType)

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

settings

public CreateIndexRequest settings(XContentBuilder builder)

Allows to set the settings using a json builder.

settings

public CreateIndexRequest settings(Map<String,?> source)

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

mapping

public CreateIndexRequest mapping(String mapping)

Set the mapping for this index The mapping should be in the form of a JSON string, with an outer _doc key

     .mapping("{\"_doc\":{\"properties\": ... }}")
 

mapping

public CreateIndexRequest mapping(XContentBuilder source)

Set the mapping for this index

Parameters:

source - The mapping source

mapping

public CreateIndexRequest mapping(Map<String,?> source)

Set the mapping for this index

Parameters:

source - The mapping source

simpleMapping

public CreateIndexRequest simpleMapping(String... source)

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

cause

public CreateIndexRequest cause(String cause)

The cause for this index creation.

aliases

public CreateIndexRequest aliases(Map<String,?> source)

Sets the aliases that will be associated with the index when it gets created

aliases

public CreateIndexRequest aliases(XContentBuilder source)

Sets the aliases that will be associated with the index when it gets created

aliases

public CreateIndexRequest aliases(String source)

Sets the aliases that will be associated with the index when it gets created

aliases

public CreateIndexRequest aliases(BytesReference source)

Sets the aliases that will be associated with the index when it gets created

alias

public CreateIndexRequest alias(Alias alias)

Adds an alias that will be associated with the index when it gets created

source

public CreateIndexRequest source(String source,
 XContentType xContentType)

Sets the settings and mappings as a single source.

source

public CreateIndexRequest source(XContentBuilder source)

Sets the settings and mappings as a single source.

source

public CreateIndexRequest source(byte[] source,
 XContentType xContentType)

Sets the settings and mappings as a single source.

source

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

Sets the settings and mappings as a single source.

source

public CreateIndexRequest source(BytesReference source,
 XContentType xContentType)

Sets the settings and mappings as a single source.

source

public CreateIndexRequest source(Map<String,?> source,
 DeprecationHandler deprecationHandler)

Sets the settings and mappings as a single source.

mappings

public String mappings()

aliases

public Set<Alias> aliases()

waitForActiveShards

public ActiveShardCount waitForActiveShards()

waitForActiveShards

public CreateIndexRequest waitForActiveShards(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

waitForActiveShards

public CreateIndexRequest waitForActiveShards(int waitForActiveShards)

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

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<CreateIndexRequest>

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object