Package co.elastic.clients.elasticsearch.indices

Class CreateIndexRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.CreateIndexRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CreateIndexRequest
extends RequestBase
implements JsonpSerializable

Creates an index with optional settings and mappings.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateIndexRequest.Builder	Builder for CreateIndexRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CreateIndexRequest>	_DESERIALIZER	Json deserializer for CreateIndexRequest
static final Endpoint<CreateIndexRequest,CreateIndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.create".

Method Summary

Modifier and Type	Method	Description
final Map<String,Alias>	aliases()	API name: aliases
final String	index()	Required - The name of the index
final TypeMapping	mappings()	Mapping for fields in the index.
final Time	masterTimeout()	Specify timeout for connection to master
static CreateIndexRequest	of(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
final IndexSettings	settings()	API name: settings
protected static void	setupCreateIndexRequestDeserializer(ObjectDeserializer<CreateIndexRequest.Builder> op)
final Time	timeout()	Explicit operation timeout
final WaitForActiveShards	waitForActiveShards()	Set the number of active shards to wait for before the operation returns.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CreateIndexRequest> _DESERIALIZER

Json deserializer for CreateIndexRequest

_ENDPOINT

public static final Endpoint<CreateIndexRequest,CreateIndexResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.create".

Method Details

of

public static CreateIndexRequest of(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)

aliases

public final Map<String,Alias> aliases()

API name: aliases

index

public final String index()

Required - The name of the index

API name: index

mappings

@Nullable
public final TypeMapping mappings()

Mapping for fields in the index. If specified, this mapping can include:

• Field names
• Field data types
• Mapping parameters

API name: mappings

masterTimeout

@Nullable
public final Time masterTimeout()

Specify timeout for connection to master

API name: master_timeout

settings

@Nullable
public final IndexSettings settings()

API name: settings

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

waitForActiveShards

@Nullable
public final WaitForActiveShards waitForActiveShards()

Set the number of active shards to wait for before the operation returns.

API name: wait_for_active_shards

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupCreateIndexRequestDeserializer

protected static void setupCreateIndexRequestDeserializer(ObjectDeserializer<CreateIndexRequest.Builder> op)