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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<CreateIndexRequest> Json deserializer forCreateIndexRequeststatic final Endpoint<CreateIndexRequest, CreateIndexResponse, ErrorResponse> Endpoint "indices.create". -
Method Summary
Modifier and TypeMethodDescriptionaliases()Aliases for the index.protected voidapplyQueryParameters(Map<String, String> params) static CreateIndexRequest.Builderbuilder()final TimeOperation timeout for connection to cluster-manager node.booleaninthashCode()final Stringindex()Required - Name of the index you wish to create.final TypeMappingmappings()API name:mappingsfinal TimeDeprecated.static CreateIndexRequestvoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) final IndexSettingssettings()API name:settingsprotected static voidfinal Timetimeout()Period to wait for a response.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.final WaitForActiveShardsThe number of shard copies that must be active before proceeding with the operation.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forCreateIndexRequest -
_ENDPOINT
Endpoint "indices.create".
-
-
Method Details
-
of
public static CreateIndexRequest of(Function<CreateIndexRequest.Builder, ObjectBuilder<CreateIndexRequest>> fn) -
aliases
Aliases for the index.API name:
aliases -
clusterManagerTimeout
Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
index
Required - Name of the index you wish to create.API name:
index -
mappings
API name:mappings -
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
API name:settings -
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
The number of shard copies that must be active before proceeding with the operation. Set toallor any positive integer up to the total number of shards in the index (number_of_replicas+1).API name:
wait_for_active_shards -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest> - Returns:
- a new builder instance.
-
builder
-
setupCreateIndexRequestDeserializer
protected static void setupCreateIndexRequestDeserializer(ObjectDeserializer<CreateIndexRequest.Builder> op) -
applyQueryParameters
- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode() -
equals
-