Class ReindexRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ReindexRequest.Builder>
org.opensearch.client.opensearch.core.ReindexRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<ReindexRequest.Builder,,ReindexRequest> MutableBuilder<ReindexRequest.Builder,,ReindexRequest> ObjectBuilder<ReindexRequest>
- Enclosing class:
ReindexRequest
public static class ReindexRequest.Builder
extends RequestBase.AbstractBuilder<ReindexRequest.Builder>
implements CopyableBuilder<ReindexRequest.Builder,ReindexRequest>
Builder for
ReindexRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aReindexRequest.final ReindexRequest.BuilderAPI name:conflictscopy()Create a new builderCopyableBuilderthat is a copy of this one.final ReindexRequest.BuilderRequired - API name:destfinal ReindexRequest.Builderdest(Destination value) Required - API name:destfinal ReindexRequest.BuilderThe maximum number of documents to reindex.final ReindexRequest.BuilderIftrue, the request refreshes affected shards to make this operation visible to search.final ReindexRequest.BuilderrequestsPerSecond(Float value) The throttle for this request in sub-requests per second.final ReindexRequest.BuilderrequireAlias(Boolean value) API name:require_aliasfinal ReindexRequest.BuilderAPI name:scriptfinal ReindexRequest.BuilderAPI name:scriptfinal ReindexRequest.BuilderSpecifies how long a consistent view of the index should be maintained for scrolled search.final ReindexRequest.BuilderSpecifies how long a consistent view of the index should be maintained for scrolled search.protected ReindexRequest.Builderself()final ReindexRequest.BuilderAPI name:sizefinal ReindexRequest.BuilderThe number of slices this task should be divided into.final ReindexRequest.BuilderThe number of slices this task should be divided into.final ReindexRequest.BuilderRequired - API name:sourcefinal ReindexRequest.BuilderRequired - API name:sourcefinal ReindexRequest.BuilderPeriod each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.final ReindexRequest.BuilderPeriod each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.final ReindexRequest.BuilderThe number of shard copies that must be active before proceeding with the operation.final ReindexRequest.BuilderThe number of shard copies that must be active before proceeding with the operation.final ReindexRequest.BuilderwaitForCompletion(Boolean value) Iftrue, the request blocks until the operation is complete.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<ReindexRequest.Builder,ReindexRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<ReindexRequest.Builder>
-
conflicts
API name:conflicts -
dest
Required - API name:dest -
dest
@Nonnull public final ReindexRequest.Builder dest(Function<Destination.Builder, ObjectBuilder<Destination>> fn) Required - API name:dest -
maxDocs
The maximum number of documents to reindex.API name:
max_docs -
refresh
Iftrue, the request refreshes affected shards to make this operation visible to search.API name:
refresh -
requestsPerSecond
The throttle for this request in sub-requests per second. Defaults to no throttle.API name:
requests_per_second -
requireAlias
API name:require_alias -
script
API name:script -
script
@Nonnull public final ReindexRequest.Builder script(Function<Script.Builder, ObjectBuilder<Script>> fn) API name:script -
scroll
Specifies how long a consistent view of the index should be maintained for scrolled search.API name:
scroll -
scroll
Specifies how long a consistent view of the index should be maintained for scrolled search.API name:
scroll -
size
API name:size -
slices
The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.API name:
slices -
slices
@Nonnull public final ReindexRequest.Builder slices(Function<Slices.Builder, ObjectBuilder<Slices>> fn) The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.API name:
slices -
source
Required - API name:source -
source
@Nonnull public final ReindexRequest.Builder source(Function<Source.Builder, ObjectBuilder<Source>> fn) Required - API name:source -
timeout
Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.API name:
timeout -
timeout
Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.API name:
timeout -
waitForActiveShards
@Nonnull public final ReindexRequest.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 ReindexRequest.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
Iftrue, the request blocks until the operation is complete.API name:
wait_for_completion -
build
Builds aReindexRequest.- Specified by:
buildin interfaceObjectBuilder<ReindexRequest>- Throws:
NullPointerException- if some of the required fields are null.
-