Package org.opensearch.client.opensearch.core

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ReindexRequest	build()	Builds a ReindexRequest.
final ReindexRequest.Builder	conflicts(Conflicts value)	API name: conflicts
ReindexRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ReindexRequest.Builder	dest(Function<Destination.Builder,ObjectBuilder<Destination>> fn)	Required - API name: dest
final ReindexRequest.Builder	dest(Destination value)	Required - API name: dest
final ReindexRequest.Builder	maxDocs(Integer value)	The maximum number of documents to reindex.
final ReindexRequest.Builder	refresh(Refresh value)	If true, the request refreshes affected shards to make this operation visible to search.
final ReindexRequest.Builder	requestsPerSecond(Float value)	The throttle for this request in sub-requests per second.
final ReindexRequest.Builder	requireAlias(Boolean value)	API name: require_alias
final ReindexRequest.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final ReindexRequest.Builder	script(Script value)	API name: script
final ReindexRequest.Builder	scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specifies how long a consistent view of the index should be maintained for scrolled search.
final ReindexRequest.Builder	scroll(Time value)	Specifies how long a consistent view of the index should be maintained for scrolled search.
protected ReindexRequest.Builder	self()
final ReindexRequest.Builder	size(Integer value)	API name: size
final ReindexRequest.Builder	slices(Function<Slices.Builder,ObjectBuilder<Slices>> fn)	The number of slices this task should be divided into.
final ReindexRequest.Builder	slices(Slices value)	The number of slices this task should be divided into.
final ReindexRequest.Builder	source(Function<Source.Builder,ObjectBuilder<Source>> fn)	Required - API name: source
final ReindexRequest.Builder	source(Source value)	Required - API name: source
final ReindexRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.
final ReindexRequest.Builder	timeout(Time value)	Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.
final ReindexRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.
final ReindexRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.
final ReindexRequest.Builder	waitForCompletion(Boolean value)	If true, the request blocks until the operation is complete.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ReindexRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ReindexRequest.Builder,ReindexRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ReindexRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ReindexRequest.Builder>

conflicts

@Nonnull
public final ReindexRequest.Builder conflicts(@Nullable
 Conflicts value)

API name: conflicts

dest

@Nonnull
public final ReindexRequest.Builder dest(Destination value)

Required - API name: dest

dest

@Nonnull
public final ReindexRequest.Builder dest(Function<Destination.Builder,ObjectBuilder<Destination>> fn)

Required - API name: dest

maxDocs

@Nonnull
public final ReindexRequest.Builder maxDocs(@Nullable
 Integer value)

The maximum number of documents to reindex.

API name: max_docs

refresh

@Nonnull
public final ReindexRequest.Builder refresh(@Nullable
 Refresh value)

If true, the request refreshes affected shards to make this operation visible to search.

API name: refresh

requestsPerSecond

@Nonnull
public final ReindexRequest.Builder requestsPerSecond(@Nullable
 Float value)

The throttle for this request in sub-requests per second. Defaults to no throttle.

API name: requests_per_second

requireAlias

@Nonnull
public final ReindexRequest.Builder requireAlias(@Nullable
 Boolean value)

API name: require_alias

script

@Nonnull
public final ReindexRequest.Builder script(@Nullable
 Script value)

API name: script

script

@Nonnull
public final ReindexRequest.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

scroll

@Nonnull
public final ReindexRequest.Builder scroll(@Nullable
 Time value)

Specifies how long a consistent view of the index should be maintained for scrolled search.

API name: scroll

scroll

@Nonnull
public final ReindexRequest.Builder scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)

Specifies how long a consistent view of the index should be maintained for scrolled search.

API name: scroll

size

@Nonnull
public final ReindexRequest.Builder size(@Nullable
 Integer value)

API name: size

slices

@Nonnull
public final ReindexRequest.Builder slices(@Nullable
 Slices value)

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

@Nonnull
public final ReindexRequest.Builder source(Source value)

Required - API name: source

source

@Nonnull
public final ReindexRequest.Builder source(Function<Source.Builder,ObjectBuilder<Source>> fn)

Required - API name: source

timeout

@Nonnull
public final ReindexRequest.Builder timeout(@Nullable
 Time value)

Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.

API name: timeout

timeout

@Nonnull
public final ReindexRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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 to all or 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 to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

API name: wait_for_active_shards

waitForCompletion

@Nonnull
public final ReindexRequest.Builder waitForCompletion(@Nullable
 Boolean value)

If true, the request blocks until the operation is complete.

API name: wait_for_completion

build

@Nonnull
public ReindexRequest build()

Builds a ReindexRequest.

Specified by:

build in interface ObjectBuilder<ReindexRequest>

Throws:

NullPointerException - if some of the required fields are null.