Package org.opensearch.client.opensearch.indices

Class CloneIndexRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

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

Enclosing class:

CloneIndexRequest

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

Builder for CloneIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CloneIndexRequest.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Aliases for the resulting index.
final CloneIndexRequest.Builder	aliases(String key, Alias value)	Aliases for the resulting index.
final CloneIndexRequest.Builder	aliases(Map<String,Alias> map)	Aliases for the resulting index.
CloneIndexRequest	build()	Builds a CloneIndexRequest.
final CloneIndexRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final CloneIndexRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
CloneIndexRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CloneIndexRequest.Builder	index(String value)	Required - Name of the source index to clone.
final CloneIndexRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final CloneIndexRequest.Builder	masterTimeout(Time value)	Deprecated.
protected CloneIndexRequest.Builder	self()
final CloneIndexRequest.Builder	settings(String key, JsonData value)	Configuration options for the target index.
final CloneIndexRequest.Builder	settings(Map<String,JsonData> map)	Configuration options for the target index.
final CloneIndexRequest.Builder	target(String value)	Required - Name of the target index to create.
final CloneIndexRequest.Builder	taskExecutionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
final CloneIndexRequest.Builder	taskExecutionTimeout(Time value)	Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
final CloneIndexRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final CloneIndexRequest.Builder	timeout(Time value)	Period to wait for a response.
final CloneIndexRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.
final CloneIndexRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.
final CloneIndexRequest.Builder	waitForCompletion(Boolean value)	Should this request wait until the operation has completed before returning.

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 CloneIndexRequest.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<CloneIndexRequest.Builder,CloneIndexRequest>

Returns:

a new builder instance.

self

@Nonnull
protected CloneIndexRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CloneIndexRequest.Builder>

aliases

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

Aliases for the resulting index.

API name: aliases

Adds all elements of map to aliases.

aliases

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

Aliases for the resulting index.

API name: aliases

Adds an entry to aliases.

aliases

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

Aliases for the resulting index.

API name: aliases

Adds a value to aliases using a builder lambda.

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Required - Name of the source index to clone.

API name: index

masterTimeout

@Deprecated
@Nonnull
public final CloneIndexRequest.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 CloneIndexRequest.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 CloneIndexRequest.Builder settings(Map<String,JsonData> map)

Configuration options for the target index.

API name: settings

Adds all elements of map to settings.

settings

@Nonnull
public final CloneIndexRequest.Builder settings(String key,
 JsonData value)

Configuration options for the target index.

API name: settings

Adds an entry to settings.

target

@Nonnull
public final CloneIndexRequest.Builder target(String value)

Required - Name of the target index to create.

API name: target

taskExecutionTimeout

@Nonnull
public final CloneIndexRequest.Builder taskExecutionTimeout(@Nullable
 Time value)

Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

API name: task_execution_timeout

taskExecutionTimeout

@Nonnull
public final CloneIndexRequest.Builder taskExecutionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

API name: task_execution_timeout

timeout

@Nonnull
public final CloneIndexRequest.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 CloneIndexRequest.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 CloneIndexRequest.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 CloneIndexRequest.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

waitForCompletion

@Nonnull
public final CloneIndexRequest.Builder waitForCompletion(@Nullable
 Boolean value)

Should this request wait until the operation has completed before returning.

API name: wait_for_completion

build

@Nonnull
public CloneIndexRequest build()

Builds a CloneIndexRequest.

Specified by:

build in interface ObjectBuilder<CloneIndexRequest>

Throws:

NullPointerException - if some of the required fields are null.