Package org.opensearch.client.opensearch.core

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 for ReindexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ReindexRequest	build()	Builds a ReindexRequest.
ReindexRequest.Builder	conflicts(Conflicts value)	API name: conflicts
ReindexRequest.Builder	dest(java.util.function.Function<Destination.Builder,ObjectBuilder<Destination>> fn)	API name: dest
ReindexRequest.Builder	dest(Destination value)	API name: dest
ReindexRequest.Builder	maxDocs(java.lang.Long value)	API name: max_docs
ReindexRequest.Builder	refresh(java.lang.Boolean value)	Should the affected indexes be refreshed?
ReindexRequest.Builder	requestsPerSecond(java.lang.Long value)	The throttle to set on this request in sub-requests per second.
ReindexRequest.Builder	requireAlias(java.lang.Boolean value)	API name: require_alias
ReindexRequest.Builder	script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
ReindexRequest.Builder	script(Script value)	API name: script
ReindexRequest.Builder	scroll(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Control how long to keep the search context alive
ReindexRequest.Builder	scroll(Time value)	Control how long to keep the search context alive
ReindexRequest.Builder	size(java.lang.Long value)	API name: size
ReindexRequest.Builder	slices(java.lang.Long value)	The number of slices this task should be divided into.
ReindexRequest.Builder	source(java.util.function.Function<Source.Builder,ObjectBuilder<Source>> fn)	API name: source
ReindexRequest.Builder	source(Source value)	API name: source
ReindexRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Time each individual bulk request should wait for shards that are unavailable.
ReindexRequest.Builder	timeout(Time value)	Time each individual bulk request should wait for shards that are unavailable.
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.
ReindexRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Sets the number of shard copies that must be active before proceeding with the reindex operation.
ReindexRequest.Builder	waitForCompletion(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

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 alive

API 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 alive

API 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 for auto.

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 to all for 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 to all for 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 a ReindexRequest.

Specified by:

build in interface ObjectBuilder<ReindexRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.