Package org.opensearch.client.opensearch._types

Class BulkByScrollTaskStatus.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.BulkByScrollTaskStatus.Builder

All Implemented Interfaces:

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

Enclosing class:

BulkByScrollTaskStatus

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

Builder for BulkByScrollTaskStatus.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final BulkByScrollTaskStatus.Builder	batches(int value)	Required - The number of scroll responses pulled back by the reindex operation.
BulkByScrollTaskStatus	build()	Builds a BulkByScrollTaskStatus.
final BulkByScrollTaskStatus.Builder	canceled(String value)	API name: canceled
BulkByScrollTaskStatus.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final BulkByScrollTaskStatus.Builder	created(Long value)	The number of documents that were successfully created.
final BulkByScrollTaskStatus.Builder	deleted(long value)	Required - The number of documents that were successfully deleted.
final BulkByScrollTaskStatus.Builder	noops(long value)	Required - The number of documents that were ignored.
final BulkByScrollTaskStatus.Builder	requestsPerSecond(float value)	Required - The number of requests per second effectively executed during the reindex operation.
final BulkByScrollTaskStatus.Builder	retries(Function<Retries.Builder,ObjectBuilder<Retries>> fn)	Required - API name: retries
final BulkByScrollTaskStatus.Builder	retries(Retries value)	Required - API name: retries
final BulkByScrollTaskStatus.Builder	sliceId(Integer value)	API name: slice_id
final BulkByScrollTaskStatus.Builder	slices(Function<BulkByScrollTaskStatusOrException.Builder,ObjectBuilder<BulkByScrollTaskStatusOrException>> fn)	API name: slices
final BulkByScrollTaskStatus.Builder	slices(List<BulkByScrollTaskStatusOrException> list)	API name: slices
final BulkByScrollTaskStatus.Builder	slices(BulkByScrollTaskStatusOrException value, BulkByScrollTaskStatusOrException... values)	API name: slices
final BulkByScrollTaskStatus.Builder	throttled(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: throttled
final BulkByScrollTaskStatus.Builder	throttled(Time value)	API name: throttled
final BulkByScrollTaskStatus.Builder	throttledMillis(long value)	Required - API name: throttled_millis
final BulkByScrollTaskStatus.Builder	throttledUntil(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount time before the throttling will end.
final BulkByScrollTaskStatus.Builder	throttledUntil(Time value)	The amount time before the throttling will end.
final BulkByScrollTaskStatus.Builder	throttledUntilMillis(long value)	Required - When the throttling will end in milliseconds.
final BulkByScrollTaskStatus.Builder	total(long value)	Required - The number of documents that were successfully processed.
final BulkByScrollTaskStatus.Builder	updated(Long value)	The number of documents that were successfully updated after the reindex operation.
final BulkByScrollTaskStatus.Builder	versionConflicts(long value)	Required - The number of version conflicts encountered by the reindex operation.

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

Returns:

a new builder instance.

batches

@Nonnull
public final BulkByScrollTaskStatus.Builder batches(int value)

Required - The number of scroll responses pulled back by the reindex operation.

API name: batches

canceled

@Nonnull
public final BulkByScrollTaskStatus.Builder canceled(@Nullable
 String value)

API name: canceled

created

@Nonnull
public final BulkByScrollTaskStatus.Builder created(@Nullable
 Long value)

The number of documents that were successfully created.

API name: created

deleted

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

Required - The number of documents that were successfully deleted.

API name: deleted

noops

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

Required - The number of documents that were ignored.

API name: noops

requestsPerSecond

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

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

API name: requests_per_second

retries

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

Required - API name: retries

retries

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

Required - API name: retries

sliceId

@Nonnull
public final BulkByScrollTaskStatus.Builder sliceId(@Nullable
 Integer value)

API name: slice_id

slices

@Nonnull
public final BulkByScrollTaskStatus.Builder slices(List<BulkByScrollTaskStatusOrException> list)

API name: slices

Adds all elements of list to slices.

slices

@Nonnull
public final BulkByScrollTaskStatus.Builder slices(BulkByScrollTaskStatusOrException value,
 BulkByScrollTaskStatusOrException... values)

API name: slices

Adds one or more values to slices.

slices

@Nonnull
public final BulkByScrollTaskStatus.Builder slices(Function<BulkByScrollTaskStatusOrException.Builder,ObjectBuilder<BulkByScrollTaskStatusOrException>> fn)

API name: slices

Adds a value to slices using a builder lambda.

throttled

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

API name: throttled

throttled

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

API name: throttled

throttledMillis

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

Required - API name: throttled_millis

throttledUntil

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

The amount time before the throttling will end.

API name: throttled_until

throttledUntil

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

The amount time before the throttling will end.

API name: throttled_until

throttledUntilMillis

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

Required - When the throttling will end in milliseconds.

API name: throttled_until_millis

total

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

Required - The number of documents that were successfully processed.

API name: total

updated

@Nonnull
public final BulkByScrollTaskStatus.Builder updated(@Nullable
 Long value)

The number of documents that were successfully updated after the reindex operation.

API name: updated

versionConflicts

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

Required - The number of version conflicts encountered by the reindex operation.

API name: version_conflicts

build

@Nonnull
public BulkByScrollTaskStatus build()

Builds a BulkByScrollTaskStatus.

Specified by:

build in interface ObjectBuilder<BulkByScrollTaskStatus>

Throws:

NullPointerException - if some of the required fields are null.