Package co.elastic.clients.elasticsearch.indices

Class CreateIndexRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.indices.CreateIndexRequest.Builder

All Implemented Interfaces:

ObjectBuilder<CreateIndexRequest>

Enclosing class:

CreateIndexRequest

public static class CreateIndexRequest.Builder
extends java.lang.Object
implements ObjectBuilder<CreateIndexRequest>

Builder for CreateIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateIndexRequest.Builder	aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Set aliases(Map) to a singleton map.
CreateIndexRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> value)	API name: aliases
CreateIndexRequest	build()	Builds a CreateIndexRequest.
CreateIndexRequest.Builder	includeTypeName(java.lang.Boolean value)	Whether a type should be expected in the body of the mappings.
CreateIndexRequest.Builder	index(java.lang.String value)	Required - The name of the index
CreateIndexRequest.Builder	mappings(jakarta.json.JsonValue value)	Mapping for fields in the index.
CreateIndexRequest.Builder	masterTimeout(java.lang.String value)	Specify timeout for connection to master
CreateIndexRequest.Builder	putAliases(java.lang.String key, Alias value)	Add a key/value to aliases(Map), creating the map if needed.
CreateIndexRequest.Builder	putAliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Add a key/value to aliases(Map), creating the map if needed.
CreateIndexRequest.Builder	putSettings(java.lang.String key, JsonData value)	Add a key/value to settings(Map), creating the map if needed.
CreateIndexRequest.Builder	settings(java.util.Map<java.lang.String,JsonData> value)	API name: settings
CreateIndexRequest.Builder	timeout(java.lang.String value)	Explicit operation timeout
CreateIndexRequest.Builder	waitForActiveShards(jakarta.json.JsonValue value)	Set the number of active shards to wait for before the operation returns.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

public CreateIndexRequest.Builder index(java.lang.String value)

Required - The name of the index

API name: index

includeTypeName

public CreateIndexRequest.Builder includeTypeName(@Nullable
java.lang.Boolean value)

Whether a type should be expected in the body of the mappings.

API name: include_type_name

masterTimeout

public CreateIndexRequest.Builder masterTimeout(@Nullable
java.lang.String value)

Specify timeout for connection to master

API name: master_timeout

timeout

public CreateIndexRequest.Builder timeout(@Nullable
java.lang.String value)

Explicit operation timeout

API name: timeout

waitForActiveShards

public CreateIndexRequest.Builder waitForActiveShards(@Nullable
jakarta.json.JsonValue value)

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

API name: wait_for_active_shards

aliases

public CreateIndexRequest.Builder aliases(@Nullable
java.util.Map<java.lang.String,Alias> value)

API name: aliases

putAliases

public CreateIndexRequest.Builder putAliases(java.lang.String key,
Alias value)

Add a key/value to aliases(Map), creating the map if needed.

aliases

public CreateIndexRequest.Builder aliases(java.lang.String key,
java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Set aliases(Map) to a singleton map.

putAliases

public CreateIndexRequest.Builder putAliases(java.lang.String key,
java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Add a key/value to aliases(Map), creating the map if needed.

mappings

public CreateIndexRequest.Builder mappings(@Nullable
jakarta.json.JsonValue value)

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

• Field names
• Field data types
• Mapping parameters

API name: mappings

settings

public CreateIndexRequest.Builder settings(@Nullable
java.util.Map<java.lang.String,JsonData> value)

API name: settings

putSettings

public CreateIndexRequest.Builder putSettings(java.lang.String key,
JsonData value)

Add a key/value to settings(Map), creating the map if needed.

build

public CreateIndexRequest build()

Builds a CreateIndexRequest.

Specified by:

build in interface ObjectBuilder<CreateIndexRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.