Package org.opensearch.client.opensearch.indices

Class CreateIndexRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<CreateIndexRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, MutableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, ObjectBuilder<CreateIndexRequest>

Enclosing class:

CreateIndexRequest

public static class CreateIndexRequest.Builder
extends RequestBase.AbstractBuilder<CreateIndexRequest.Builder>
implements CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Builder for CreateIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CreateIndexRequest.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Aliases for the index.
final CreateIndexRequest.Builder	aliases(String key, Alias value)	Aliases for the index.
final CreateIndexRequest.Builder	aliases(Map<String,Alias> map)	Aliases for the index.
CreateIndexRequest	build()	Builds a CreateIndexRequest.
final CreateIndexRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final CreateIndexRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
CreateIndexRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CreateIndexRequest.Builder	index(String value)	Required - Name of the index you wish to create.
final CreateIndexRequest.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: mappings
final CreateIndexRequest.Builder	mappings(TypeMapping value)	API name: mappings
final CreateIndexRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final CreateIndexRequest.Builder	masterTimeout(Time value)	Deprecated.
protected CreateIndexRequest.Builder	self()
final CreateIndexRequest.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: settings
final CreateIndexRequest.Builder	settings(IndexSettings value)	API name: settings
final CreateIndexRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final CreateIndexRequest.Builder	timeout(Time value)	Period to wait for a response.
final CreateIndexRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.
final CreateIndexRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public CreateIndexRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Returns:

a new builder instance.

self

@Nonnull
protected CreateIndexRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CreateIndexRequest.Builder>

aliases

@Nonnull
public final CreateIndexRequest.Builder aliases(Map<String,Alias> map)

Aliases for the index.

API name: aliases

Adds all elements of map to aliases.

aliases

@Nonnull
public final CreateIndexRequest.Builder aliases(String key,
 Alias value)

Aliases for the index.

API name: aliases

Adds an entry to aliases.

aliases

@Nonnull
public final CreateIndexRequest.Builder aliases(String key,
 Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Aliases for the index.

API name: aliases

Adds a value to aliases using a builder lambda.

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final CreateIndexRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

index

@Nonnull
public final CreateIndexRequest.Builder index(String value)

Required - Name of the index you wish to create.

API name: index

mappings

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

API name: mappings

mappings

@Nonnull
public final CreateIndexRequest.Builder mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

API name: mappings

masterTimeout

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

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

masterTimeout

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

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

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

API name: settings

settings

@Nonnull
public final CreateIndexRequest.Builder settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

API name: settings

timeout

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

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

@Nonnull
public final CreateIndexRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

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

The number of shard copies that must be active before proceeding with the operation. Set to all 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

@Nonnull
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 to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

API name: wait_for_active_shards

build

@Nonnull
public CreateIndexRequest build()

Builds a CreateIndexRequest.

Specified by:

build in interface ObjectBuilder<CreateIndexRequest>

Throws:

NullPointerException - if some of the required fields are null.