Package org.opensearch.client.opensearch.core.reindex_rethrottle

Class ReindexStatus.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.reindex_rethrottle.ReindexStatus.Builder

All Implemented Interfaces:

CopyableBuilder<ReindexStatus.Builder,ReindexStatus>, MutableBuilder<ReindexStatus.Builder,ReindexStatus>, ObjectBuilder<ReindexStatus>

Enclosing class:

ReindexStatus

public static class ReindexStatus.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ReindexStatus.Builder,ReindexStatus>

Builder for ReindexStatus.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ReindexStatus.Builder	batches(long value)	Required - The number of scroll responses shown by the reindex.
ReindexStatus	build()	Builds a ReindexStatus.
ReindexStatus.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ReindexStatus.Builder	created(long value)	Required - The number of documents that were successfully created.
final ReindexStatus.Builder	deleted(long value)	Required - The number of documents that were successfully deleted.
final ReindexStatus.Builder	noops(long value)	Required - The number of documents that were ignored because the script used for the reindex operation returned a noop value for ctx.op.
final ReindexStatus.Builder	requestsPerSecond(float value)	Required - The number of successful requests per second during the reindex operation.
final ReindexStatus.Builder	retries(Function<Retries.Builder,ObjectBuilder<Retries>> fn)	Required - API name: retries
final ReindexStatus.Builder	retries(Retries value)	Required - API name: retries
final ReindexStatus.Builder	throttled(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: throttled
final ReindexStatus.Builder	throttled(Time value)	API name: throttled
final ReindexStatus.Builder	throttledMillis(long value)	Required - API name: throttled_millis
final ReindexStatus.Builder	throttledUntil(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: throttled_until
final ReindexStatus.Builder	throttledUntil(Time value)	API name: throttled_until
final ReindexStatus.Builder	throttledUntilMillis(long value)	Required - API name: throttled_until_millis
final ReindexStatus.Builder	total(long value)	Required - The number of documents that were successfully processed.
final ReindexStatus.Builder	updated(long value)	Required - The number of documents that were successfully updated.
final ReindexStatus.Builder	versionConflicts(long value)	Required - The number of version conflicts that reindex hits.

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 ReindexStatus.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<ReindexStatus.Builder,ReindexStatus>

Returns:

a new builder instance.

batches

@Nonnull
public final ReindexStatus.Builder batches(long value)

Required - The number of scroll responses shown by the reindex.

API name: batches

created

@Nonnull
public final ReindexStatus.Builder created(long value)

Required - The number of documents that were successfully created.

API name: created

deleted

@Nonnull
public final ReindexStatus.Builder deleted(long value)

Required - The number of documents that were successfully deleted.

API name: deleted

noops

@Nonnull
public final ReindexStatus.Builder noops(long value)

Required - The number of documents that were ignored because the script used for the reindex operation returned a noop value for ctx.op.

API name: noops

requestsPerSecond

@Nonnull
public final ReindexStatus.Builder requestsPerSecond(float value)

Required - The number of successful requests per second during the reindex operation.

API name: requests_per_second

retries

@Nonnull
public final ReindexStatus.Builder retries(Retries value)

Required - API name: retries

retries

@Nonnull
public final ReindexStatus.Builder retries(Function<Retries.Builder,ObjectBuilder<Retries>> fn)

Required - API name: retries

throttled

@Nonnull
public final ReindexStatus.Builder throttled(@Nullable
 Time value)

API name: throttled

throttled

@Nonnull
public final ReindexStatus.Builder throttled(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: throttled

throttledMillis

@Nonnull
public final ReindexStatus.Builder throttledMillis(long value)

Required - API name: throttled_millis

throttledUntil

@Nonnull
public final ReindexStatus.Builder throttledUntil(@Nullable
 Time value)

API name: throttled_until

throttledUntil

@Nonnull
public final ReindexStatus.Builder throttledUntil(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: throttled_until

throttledUntilMillis

@Nonnull
public final ReindexStatus.Builder throttledUntilMillis(long value)

Required - API name: throttled_until_millis

total

@Nonnull
public final ReindexStatus.Builder total(long value)

Required - The number of documents that were successfully processed.

API name: total

updated

@Nonnull
public final ReindexStatus.Builder updated(long value)

Required - The number of documents that were successfully updated.

API name: updated

versionConflicts

@Nonnull
public final ReindexStatus.Builder versionConflicts(long value)

Required - The number of version conflicts that reindex hits.

API name: version_conflicts

build

@Nonnull
public ReindexStatus build()

Builds a ReindexStatus.

Specified by:

build in interface ObjectBuilder<ReindexStatus>

Throws:

NullPointerException - if some of the required fields are null.