Class CreateIndexRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CreateIndexRequest.Builder>
co.elastic.clients.elasticsearch.indices.CreateIndexRequest.Builder
- All Implemented Interfaces:
WithJson<CreateIndexRequest.Builder>
,ObjectBuilder<CreateIndexRequest>
- Enclosing class:
- CreateIndexRequest
public static class CreateIndexRequest.Builder
extends RequestBase.AbstractBuilder<CreateIndexRequest.Builder>
implements ObjectBuilder<CreateIndexRequest>
Builder for
CreateIndexRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAliases for the index.aliases
(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) Aliases for the index.Aliases for the index.build()
Builds aCreateIndexRequest
.Required - Name of the index you wish to create.mappings
(TypeMapping value) Mapping for fields in the index.Mapping for fields in the index.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.protected CreateIndexRequest.Builder
self()
settings
(IndexSettings value) Configuration options for the index.Configuration options for the index.Period to wait for a response.Period to wait for a response.The number of shard copies that must be active before proceeding with the operation.The number of shard copies that must be active before proceeding with the operation.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
aliases
Aliases for the index.API name:
aliases
Adds all entries of
map
toaliases
. -
aliases
Aliases for the index.API name:
aliases
Adds an entry to
aliases
. -
aliases
public final CreateIndexRequest.Builder aliases(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) Aliases for the index.API name:
aliases
Adds an entry to
aliases
using a builder lambda. -
index
Required - Name of the index you wish to create.API name:
index
-
mappings
Mapping for fields in the index. If specified, this mapping can include:- Field names
- Field data types
- Mapping parameters
API name:
mappings
-
mappings
public final CreateIndexRequest.Builder mappings(Function<TypeMapping.Builder, ObjectBuilder<TypeMapping>> fn) Mapping for fields in the index. If specified, this mapping can include:- Field names
- Field data types
- Mapping parameters
API name:
mappings
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
masterTimeout
public final CreateIndexRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
settings
Configuration options for the index.API name:
settings
-
settings
public final CreateIndexRequest.Builder settings(Function<IndexSettings.Builder, ObjectBuilder<IndexSettings>> fn) Configuration options for the index.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
-
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 toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
waitForActiveShards
public final CreateIndexRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<CreateIndexRequest.Builder>
-
build
Builds aCreateIndexRequest
.- Specified by:
build
in interfaceObjectBuilder<CreateIndexRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-