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 aCloneIndexRequest
.CloneIndexRequest.Builder
index(java.lang.String value)
Required - The name of the source index to cloneCloneIndexRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Specify timeout for connection to masterCloneIndexRequest.Builder
masterTimeout(Time value)
Specify timeout for connection to masterCloneIndexRequest.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 intoCloneIndexRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Explicit operation timeoutCloneIndexRequest.Builder
timeout(Time value)
Explicit operation timeoutCloneIndexRequest.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
aliases
API name:aliases
Adds all entries of
map
toaliases
. -
aliases
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
Required - The name of the source index to cloneAPI name:
index
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
public final CloneIndexRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Specify timeout for connection to masterAPI name:
master_timeout
-
settings
API name:settings
Adds all entries of
map
tosettings
. -
settings
API name:settings
Adds an entry to
settings
. -
target
Required - The name of the target index to clone intoAPI name:
target
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
public final CloneIndexRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
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
Builds aCloneIndexRequest
.- Specified by:
build
in interfaceObjectBuilder<CloneIndexRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-