Package org.opensearch.client.opensearch.indices

Class CreateIndexRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.CreateIndexRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CreateIndexRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Creates an index with optional settings and mappings.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._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()	Aliases for the index.
protected void	applyQueryParameters(Map<String,String> params)
static CreateIndexRequest.Builder	builder()
final Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
boolean	equals(Object o)
int	hashCode()
final String	index()	Required - Name of the index you wish to create.
final TypeMapping	mappings()	API name: mappings
final Time	masterTimeout()	Deprecated.
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()	Period to wait for a response.
CreateIndexRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final WaitForActiveShards	waitForActiveShards()	The number of shard copies that must be active before proceeding with the operation.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

@Nonnull
public final Map<String,Alias> aliases()

Aliases for the index.

API name: aliases

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

index

@Nonnull
public final String index()

Required - Name of the index you wish to create.

API name: index

mappings

@Nullable
public final TypeMapping mappings()

API name: mappings

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

settings

@Nullable
public final IndexSettings settings()

API name: settings

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

waitForActiveShards

@Nullable
public final WaitForActiveShards waitForActiveShards()

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

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)

toBuilder

@Nonnull
public CreateIndexRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CreateIndexRequest.Builder builder()

setupCreateIndexRequestDeserializer

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

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object