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 forCloneIndexRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CloneIndexRequest.Builderaliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)API name:aliasesCloneIndexRequest.Builderaliases(java.lang.String key, Alias value)API name:aliasesCloneIndexRequest.Builderaliases(java.util.Map<java.lang.String,Alias> map)API name:aliasesCloneIndexRequestbuild()Builds aCloneIndexRequest.CloneIndexRequest.BuilderclusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Specify timeout for connection to cluster-managerCloneIndexRequest.BuilderclusterManagerTimeout(Time value)Specify timeout for connection to cluster-managerCloneIndexRequest.Builderindex(java.lang.String value)Required - The name of the source index to cloneCloneIndexRequest.BuildermasterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Deprecated.CloneIndexRequest.BuildermasterTimeout(Time value)Deprecated.CloneIndexRequest.Buildersettings(java.lang.String key, JsonData value)API name:settingsCloneIndexRequest.Buildersettings(java.util.Map<java.lang.String,JsonData> map)API name:settingsCloneIndexRequest.Buildertarget(java.lang.String value)Required - The name of the target index to clone intoCloneIndexRequest.Buildertimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Explicit operation timeoutCloneIndexRequest.Buildertimeout(Time value)Explicit operation timeoutCloneIndexRequest.BuilderwaitForActiveShards(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.BuilderwaitForActiveShards(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
-
-
-
-
Method Detail
-
aliases
public final CloneIndexRequest.Builder aliases(java.util.Map<java.lang.String,Alias> map)
API name:aliasesAdds all entries of
maptoaliases.
-
aliases
public final CloneIndexRequest.Builder aliases(java.lang.String key, Alias value)
API name:aliasesAdds 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:aliasesAdds an entry to
aliasesusing a builder lambda.
-
index
public final CloneIndexRequest.Builder index(java.lang.String value)
Required - The name of the source index to cloneAPI name:
index
-
masterTimeout
@Deprecated public final CloneIndexRequest.Builder masterTimeout(@Nullable Time value)
Deprecated.Specify timeout for connection to masterAPI 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 masterAPI name:
master_timeout
-
clusterManagerTimeout
public final CloneIndexRequest.Builder clusterManagerTimeout(@Nullable Time value)
Specify timeout for connection to cluster-managerAPI 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-managerAPI name:
cluster_manager_timeout
-
settings
public final CloneIndexRequest.Builder settings(java.util.Map<java.lang.String,JsonData> map)
API name:settingsAdds all entries of
maptosettings.
-
settings
public final CloneIndexRequest.Builder settings(java.lang.String key, JsonData value)
API name:settingsAdds an entry to
settings.
-
target
public final CloneIndexRequest.Builder target(java.lang.String value)
Required - The name of the target index to clone intoAPI name:
target
-
timeout
public final CloneIndexRequest.Builder timeout(@Nullable Time value)
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
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 aCloneIndexRequest.- Specified by:
buildin interfaceObjectBuilder<CloneIndexRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-