Package co.elastic.clients.elasticsearch.core

Class ReindexRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ReindexRequest.Builder>

co.elastic.clients.elasticsearch.core.ReindexRequest.Builder

All Implemented Interfaces:

WithJson<ReindexRequest.Builder>, ObjectBuilder<ReindexRequest>

Enclosing class:

ReindexRequest

public static class ReindexRequest.Builder
extends RequestBase.AbstractBuilder<ReindexRequest.Builder>
implements ObjectBuilder<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)	Set to proceed to continue reindexing even if there are conflicts.
final ReindexRequest.Builder	dest(Destination value)	Required - The destination you are copying to.
final ReindexRequest.Builder	dest(Function<Destination.Builder,ObjectBuilder<Destination>> fn)	Required - The destination you are copying to.
final ReindexRequest.Builder	maxDocs(Long value)	The maximum number of documents to reindex.
final ReindexRequest.Builder	refresh(Boolean 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)	If true, the destination must be an index alias.
final ReindexRequest.Builder	script(Script value)	The script to run to update the document source or metadata when reindexing.
final ReindexRequest.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	The script to run to update the document source or metadata when reindexing.
final ReindexRequest.Builder	scroll(Time value)	Specifies how long a consistent view of the index should be maintained for scrolled search.
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.
protected ReindexRequest.Builder	self()
final ReindexRequest.Builder	size(Long value)	API name: size
final ReindexRequest.Builder	slices(Slices value)	The number of slices this task should be divided into.
final ReindexRequest.Builder	slices(Function<Slices.Builder,ObjectBuilder<Slices>> fn)	The number of slices this task should be divided into.
final ReindexRequest.Builder	source(Source value)	Required - The source you are copying from.
final ReindexRequest.Builder	source(Function<Source.Builder,ObjectBuilder<Source>> fn)	Required - The source you are copying from.
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	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	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.
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	waitForCompletion(Boolean value)	If true, the request blocks until the operation is complete.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

conflicts

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

Set to proceed to continue reindexing even if there are conflicts.

API name: conflicts

dest

public final ReindexRequest.Builder dest(Destination value)

Required - The destination you are copying to.

API name: dest

dest

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

Required - The destination you are copying to.

API name: dest

maxDocs

public final ReindexRequest.Builder maxDocs(@Nullable
 Long value)

The maximum number of documents to reindex.

API name: max_docs

refresh

public final ReindexRequest.Builder refresh(@Nullable
 Boolean value)

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

API name: refresh

requestsPerSecond

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

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

If true, the destination must be an index alias.

API name: require_alias

script

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

The script to run to update the document source or metadata when reindexing.

API name: script

script

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

The script to run to update the document source or metadata when reindexing.

API name: script

scroll

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

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

public final ReindexRequest.Builder size(@Nullable
 Long value)

API name: size

slices

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

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

public final ReindexRequest.Builder source(Source value)

Required - The source you are copying from.

API name: source

source

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

Required - The source you are copying from.

API name: source

timeout

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

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

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

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

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

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

API name: wait_for_completion

self

protected ReindexRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ReindexRequest.Builder>

build

public ReindexRequest build()

Builds a ReindexRequest.

Specified by:

build in interface ObjectBuilder<ReindexRequest>

Throws:

NullPointerException - if some of the required fields are null.