Class ReindexRequest.Builder
- java.lang.Object
-
- org.opensearch.client.util.ObjectBuilderBase
-
- org.opensearch.client.opensearch.core.ReindexRequest.Builder
-
- All Implemented Interfaces:
ObjectBuilder<ReindexRequest>
- Enclosing class:
- ReindexRequest
public static class ReindexRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<ReindexRequest>
Builder forReindexRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReindexRequestbuild()Builds aReindexRequest.ReindexRequest.Builderconflicts(Conflicts value)API name:conflictsReindexRequest.Builderdest(java.util.function.Function<Destination.Builder,ObjectBuilder<Destination>> fn)API name:destReindexRequest.Builderdest(Destination value)API name:destReindexRequest.BuildermaxDocs(java.lang.Long value)API name:max_docsReindexRequest.Builderrefresh(java.lang.Boolean value)Should the affected indexes be refreshed?ReindexRequest.BuilderrequestsPerSecond(java.lang.Long value)The throttle to set on this request in sub-requests per second.ReindexRequest.BuilderrequireAlias(java.lang.Boolean value)API name:require_aliasReindexRequest.Builderscript(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)API name:scriptReindexRequest.Builderscript(Script value)API name:scriptReindexRequest.Builderscroll(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Control how long to keep the search context aliveReindexRequest.Builderscroll(Time value)Control how long to keep the search context aliveReindexRequest.Buildersize(java.lang.Long value)API name:sizeReindexRequest.Builderslices(java.lang.Long value)The number of slices this task should be divided into.ReindexRequest.Buildersource(java.util.function.Function<Source.Builder,ObjectBuilder<Source>> fn)API name:sourceReindexRequest.Buildersource(Source value)API name:sourceReindexRequest.Buildertimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Time each individual bulk request should wait for shards that are unavailable.ReindexRequest.Buildertimeout(Time value)Time each individual bulk request should wait for shards that are unavailable.ReindexRequest.BuilderwaitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)Sets the number of shard copies that must be active before proceeding with the reindex operation.ReindexRequest.BuilderwaitForActiveShards(WaitForActiveShards value)Sets the number of shard copies that must be active before proceeding with the reindex operation.ReindexRequest.BuilderwaitForCompletion(java.lang.Boolean value)Should the request should block until the reindex is complete.-
Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
Method Detail
-
conflicts
public final ReindexRequest.Builder conflicts(@Nullable Conflicts value)
API name:conflicts
-
dest
public final ReindexRequest.Builder dest(@Nullable Destination value)
API name:dest
-
dest
public final ReindexRequest.Builder dest(java.util.function.Function<Destination.Builder,ObjectBuilder<Destination>> fn)
API name:dest
-
maxDocs
public final ReindexRequest.Builder maxDocs(@Nullable java.lang.Long value)
API name:max_docs
-
refresh
public final ReindexRequest.Builder refresh(@Nullable java.lang.Boolean value)
Should the affected indexes be refreshed?API name:
refresh
-
requestsPerSecond
public final ReindexRequest.Builder requestsPerSecond(@Nullable java.lang.Long value)
The throttle to set on this request in sub-requests per second. -1 means no throttle.API name:
requests_per_second
-
requireAlias
public final ReindexRequest.Builder requireAlias(@Nullable java.lang.Boolean value)
API name:require_alias
-
script
public final ReindexRequest.Builder script(@Nullable Script value)
API name:script
-
script
public final ReindexRequest.Builder script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)
API name:script
-
scroll
public final ReindexRequest.Builder scroll(@Nullable Time value)
Control how long to keep the search context aliveAPI name:
scroll
-
scroll
public final ReindexRequest.Builder scroll(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Control how long to keep the search context aliveAPI name:
scroll
-
size
public final ReindexRequest.Builder size(@Nullable java.lang.Long value)
API name:size
-
slices
public final ReindexRequest.Builder slices(@Nullable java.lang.Long value)
The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to 0 forauto.API name:
slices
-
source
public final ReindexRequest.Builder source(@Nullable Source value)
API name:source
-
source
public final ReindexRequest.Builder source(java.util.function.Function<Source.Builder,ObjectBuilder<Source>> fn)
API name:source
-
timeout
public final ReindexRequest.Builder timeout(@Nullable Time value)
Time each individual bulk request should wait for shards that are unavailable.API name:
timeout
-
timeout
public final ReindexRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Time each individual bulk request should wait for shards that are unavailable.API name:
timeout
-
waitForActiveShards
public final ReindexRequest.Builder waitForActiveShards(@Nullable WaitForActiveShards value)
Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set toallfor all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
waitForActiveShards
public final ReindexRequest.Builder waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)
Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set toallfor all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
waitForCompletion
public final ReindexRequest.Builder waitForCompletion(@Nullable java.lang.Boolean value)
Should the request should block until the reindex is complete.API name:
wait_for_completion
-
build
public ReindexRequest build()
Builds aReindexRequest.- Specified by:
buildin interfaceObjectBuilder<ReindexRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-