Package org.opensearch.client.opensearch.indices

Class CreateIndexRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.CreateIndexRequest.Builder

All Implemented Interfaces:

ObjectBuilder<CreateIndexRequest>

Enclosing class:

CreateIndexRequest

public static class CreateIndexRequest.Builder
extends ObjectBuilderBase
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)	API name: aliases
CreateIndexRequest.Builder	aliases(java.lang.String key, Alias value)	API name: aliases
CreateIndexRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> map)	API name: aliases
CreateIndexRequest	build()	Builds a CreateIndexRequest.
CreateIndexRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
CreateIndexRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
CreateIndexRequest.Builder	index(java.lang.String value)	Required - The name of the index
CreateIndexRequest.Builder	mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	Mapping for fields in the index.
CreateIndexRequest.Builder	mappings(TypeMapping value)	Mapping for fields in the index.
CreateIndexRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
CreateIndexRequest.Builder	masterTimeout(Time value)	Deprecated.
CreateIndexRequest.Builder	settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: settings
CreateIndexRequest.Builder	settings(IndexSettings value)	API name: settings
CreateIndexRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
CreateIndexRequest.Builder	timeout(Time value)	Explicit operation timeout
CreateIndexRequest.Builder	waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Set the number of active shards to wait for before the operation returns.
CreateIndexRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Set the number of active shards to wait for before the operation returns.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

aliases

public final CreateIndexRequest.Builder aliases(java.util.Map<java.lang.String,Alias> map)

API name: aliases

Adds all entries of map to aliases.

aliases

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

API name: aliases

Adds an entry to aliases.

aliases

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

API name: aliases

Adds an entry to aliases using a builder lambda.

index

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

Required - The name of the index

API name: index

mappings

public final CreateIndexRequest.Builder mappings(@Nullable
                                                 TypeMapping value)

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(java.util.function.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

@Deprecated
public final CreateIndexRequest.Builder masterTimeout(@Nullable
                                                      Time value)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final CreateIndexRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

public final CreateIndexRequest.Builder clusterManagerTimeout(@Nullable
                                                              Time value)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final CreateIndexRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

settings

public final CreateIndexRequest.Builder settings(@Nullable
                                                 IndexSettings value)

API name: settings

settings

public final CreateIndexRequest.Builder settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

API name: settings

timeout

public final CreateIndexRequest.Builder timeout(@Nullable
                                                Time value)

Explicit operation timeout

API name: timeout

timeout

public final CreateIndexRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

waitForActiveShards

public final CreateIndexRequest.Builder waitForActiveShards(@Nullable
                                                            WaitForActiveShards value)

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(java.util.function.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

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.