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 TypeMethodDescriptionAPI name:aliases
aliases
(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) API name:aliases
API name:aliases
build()
Builds aCreateIndexRequest
.includeTypeName
(Boolean value) Whether a type should be expected in the body of the mappings.Required - The name of the indexmappings
(TypeMapping value) Mapping for fields in the index.Mapping for fields in the index.masterTimeout
(Time value) Specify timeout for connection to masterSpecify timeout for connection to masterprotected CreateIndexRequest.Builder
self()
settings
(IndexSettings value) API name:settings
API name:settings
Explicit operation timeoutExplicit operation timeoutSet the number of active shards to wait for before the operation returns.Set the number of active shards to wait for before the operation returns.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
API name:aliases
Adds all entries of
map
toaliases
. -
aliases
API name:aliases
Adds an entry to
aliases
. -
aliases
public final CreateIndexRequest.Builder aliases(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) API name:aliases
Adds an entry to
aliases
using a builder lambda. -
includeTypeName
Whether a type should be expected in the body of the mappings.API name:
include_type_name
-
index
Required - The name of the indexAPI 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
Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
public final CreateIndexRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Specify timeout for connection to masterAPI name:
master_timeout
-
settings
API name:settings
-
settings
public final CreateIndexRequest.Builder settings(Function<IndexSettings.Builder, ObjectBuilder<IndexSettings>> fn) API name:settings
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
Set the number of active shards to wait for before the operation returns.API name:
wait_for_active_shards
-
waitForActiveShards
public final CreateIndexRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) Set the number of active shards to wait for before the operation returns.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.
-