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 -
Method Summary
Modifier and TypeMethodDescriptionaliases(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) Aliases for the resulting index.Aliases for the resulting index.Aliases for the resulting index.build()Builds aCloneIndexRequest.Operation timeout for connection to cluster-manager node.clusterManagerTimeout(Time value) Operation timeout for connection to cluster-manager node.copy()Create a new builderCopyableBuilderthat is a copy of this one.Required - Name of the source index to clone.Deprecated.masterTimeout(Time value) Deprecated.protected CloneIndexRequest.Builderself()Configuration options for the target index.Configuration options for the target index.Required - Name of the target index to create.Explicit task execution timeout, only useful whenwait_for_completionis false, defaults to1h.taskExecutionTimeout(Time value) Explicit task execution timeout, only useful whenwait_for_completionis false, defaults to1h.Period to wait for a response.Period to wait for a response.The number of shard copies that must be active before proceeding with the operation.The number of shard copies that must be active before proceeding with the operation.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, humanMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<CloneIndexRequest.Builder,CloneIndexRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<CloneIndexRequest.Builder>
-
aliases
Aliases for the resulting index.API name:
aliasesAdds all elements of
maptoaliases. -
aliases
Aliases for the resulting index.API name:
aliasesAdds 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:
aliasesAdds a value to
aliasesusing a builder lambda. -
clusterManagerTimeout
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
Required - Name of the source index to clone.API name:
index -
masterTimeout
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
Configuration options for the target index.API name:
settingsAdds all elements of
maptosettings. -
settings
Configuration options for the target index.API name:
settingsAdds an entry to
settings. -
target
Required - Name of the target index to create.API name:
target -
taskExecutionTimeout
Explicit task execution timeout, only useful whenwait_for_completionis false, defaults to1h.API name:
task_execution_timeout -
taskExecutionTimeout
@Nonnull public final CloneIndexRequest.Builder taskExecutionTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Explicit task execution timeout, only useful whenwait_for_completionis false, defaults to1h.API name:
task_execution_timeout -
timeout
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 toallor 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 toallor any positive integer up to the total number of shards in the index (number_of_replicas+1).API name:
wait_for_active_shards -
waitForCompletion
Should this request wait until the operation has completed before returning.API name:
wait_for_completion -
build
Builds aCloneIndexRequest.- Specified by:
buildin interfaceObjectBuilder<CloneIndexRequest>- Throws:
NullPointerException- if some of the required fields are null.
-