Package org.opensearch.client.opensearch.indices

Class CloneIndexRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.CloneIndexRequest.Builder

All Implemented Interfaces:

ObjectBuilder<CloneIndexRequest>

Enclosing class:

CloneIndexRequest

public static class CloneIndexRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<CloneIndexRequest>

Builder for CloneIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloneIndexRequest.Builder	aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	API name: aliases
CloneIndexRequest.Builder	aliases(java.lang.String key, Alias value)	API name: aliases
CloneIndexRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> map)	API name: aliases
CloneIndexRequest	build()	Builds a CloneIndexRequest.
CloneIndexRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
CloneIndexRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
CloneIndexRequest.Builder	index(java.lang.String value)	Required - The name of the source index to clone
CloneIndexRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
CloneIndexRequest.Builder	masterTimeout(Time value)	Deprecated.
CloneIndexRequest.Builder	settings(java.lang.String key, JsonData value)	API name: settings
CloneIndexRequest.Builder	settings(java.util.Map<java.lang.String,JsonData> map)	API name: settings
CloneIndexRequest.Builder	target(java.lang.String value)	Required - The name of the target index to clone into
CloneIndexRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
CloneIndexRequest.Builder	timeout(Time value)	Explicit operation timeout
CloneIndexRequest.Builder	waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Set the number of active shards to wait for on the cloned index before the operation returns.
CloneIndexRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Set the number of active shards to wait for on the cloned index 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 CloneIndexRequest.Builder aliases(java.util.Map<java.lang.String,Alias> map)

API name: aliases

Adds all entries of map to aliases.

aliases

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

API name: aliases

Adds an entry to aliases.

aliases

public final CloneIndexRequest.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 CloneIndexRequest.Builder index(java.lang.String value)

Required - The name of the source index to clone

API name: index

masterTimeout

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

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final CloneIndexRequest.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 CloneIndexRequest.Builder clusterManagerTimeout(@Nullable
                                                             Time value)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final CloneIndexRequest.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 CloneIndexRequest.Builder settings(java.util.Map<java.lang.String,JsonData> map)

API name: settings

Adds all entries of map to settings.

settings

public final CloneIndexRequest.Builder settings(java.lang.String key,
                                                JsonData value)

API name: settings

Adds an entry to settings.

target

public final CloneIndexRequest.Builder target(java.lang.String value)

Required - The name of the target index to clone into

API name: target

timeout

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

Explicit operation timeout

API name: timeout

timeout

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

Explicit operation timeout

API name: timeout

waitForActiveShards

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

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

API name: wait_for_active_shards

waitForActiveShards

public final CloneIndexRequest.Builder waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)

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

API name: wait_for_active_shards

build

public CloneIndexRequest build()

Builds a CloneIndexRequest.

Specified by:

build in interface ObjectBuilder<CloneIndexRequest>

Throws:

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