Package org.opensearch.client.opensearch.tasks

Class Status.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.tasks.Status.Builder

All Implemented Interfaces:

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

Enclosing class:

Status

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

Builder for Status.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final Status.Builder	batches(Integer value)	The number of scroll responses pulled back by the reindex operation.
Status	build()	Builds a Status.
final Status.Builder	canceled(String value)	API name: canceled
Status.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Status.Builder	created(Long value)	The number of documents that were successfully created.
final Status.Builder	deleted(Long value)	The number of documents that were successfully deleted.
final Status.Builder	metadata(String key, JsonData value)	Adds an entry to metadata.
final Status.Builder	metadata(Map<String,JsonData> map)	Adds all elements of map to metadata.
final Status.Builder	noops(Long value)	The number of documents that were ignored.
final Status.Builder	phase(String value)	API name: phase
final Status.Builder	requestsPerSecond(Float value)	The number of requests per second effectively executed during the reindex operation.
final Status.Builder	retries(Function<Retries.Builder,ObjectBuilder<Retries>> fn)	API name: retries
final Status.Builder	retries(Retries value)	API name: retries
final Status.Builder	sliceId(Integer value)	API name: slice_id
final Status.Builder	slices(Function<BulkByScrollTaskStatusOrException.Builder,ObjectBuilder<BulkByScrollTaskStatusOrException>> fn)	API name: slices
final Status.Builder	slices(List<BulkByScrollTaskStatusOrException> list)	API name: slices
final Status.Builder	slices(BulkByScrollTaskStatusOrException value, BulkByScrollTaskStatusOrException... values)	API name: slices
final Status.Builder	state(String value)	API name: state
final Status.Builder	throttled(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: throttled
final Status.Builder	throttled(Time value)	API name: throttled
final Status.Builder	throttledMillis(Long value)	API name: throttled_millis
final Status.Builder	throttledUntil(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount time before the throttling will end.
final Status.Builder	throttledUntil(Time value)	The amount time before the throttling will end.
final Status.Builder	throttledUntilMillis(Long value)	When the throttling will end in milliseconds.
final Status.Builder	total(Long value)	The number of documents that were successfully processed.
final Status.Builder	updated(Long value)	The number of documents that were successfully updated after the reindex operation.
final Status.Builder	versionConflicts(Long value)	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 Status.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<Status.Builder,Status>

Returns:

a new builder instance.

batches

@Nonnull
public final Status.Builder batches(@Nullable
 Integer value)

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

API name: batches

canceled

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

API name: canceled

created

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

The number of documents that were successfully created.

API name: created

deleted

@Nonnull
public final Status.Builder deleted(@Nullable
 Long value)

The number of documents that were successfully deleted.

API name: deleted

metadata

@Nonnull
public final Status.Builder metadata(Map<String,JsonData> map)

Adds all elements of map to metadata.

metadata

@Nonnull
public final Status.Builder metadata(String key,
 JsonData value)

Adds an entry to metadata.

noops

@Nonnull
public final Status.Builder noops(@Nullable
 Long value)

The number of documents that were ignored.

API name: noops

phase

@Nonnull
public final Status.Builder phase(@Nullable
 String value)

API name: phase

requestsPerSecond

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

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

API name: requests_per_second

retries

@Nonnull
public final Status.Builder retries(@Nullable
 Retries value)

API name: retries

retries

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

API name: retries

sliceId

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

API name: slice_id

slices

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

API name: slices

Adds all elements of list to slices.

slices

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

API name: slices

Adds one or more values to slices.

slices

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

API name: slices

Adds a value to slices using a builder lambda.

state

@Nonnull
public final Status.Builder state(@Nullable
 String value)

API name: state

throttled

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

API name: throttled

throttled

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

API name: throttled

throttledMillis

@Nonnull
public final Status.Builder throttledMillis(@Nullable
 Long value)

API name: throttled_millis

throttledUntil

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

The amount time before the throttling will end.

API name: throttled_until

throttledUntil

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

The amount time before the throttling will end.

API name: throttled_until

throttledUntilMillis

@Nonnull
public final Status.Builder throttledUntilMillis(@Nullable
 Long value)

When the throttling will end in milliseconds.

API name: throttled_until_millis

total

@Nonnull
public final Status.Builder total(@Nullable
 Long value)

The number of documents that were successfully processed.

API name: total

updated

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

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

API name: updated

versionConflicts

@Nonnull
public final Status.Builder versionConflicts(@Nullable
 Long value)

The number of version conflicts encountered by the reindex operation.

API name: version_conflicts

build

@Nonnull
public Status build()

Builds a Status.

Specified by:

build in interface ObjectBuilder<Status>

Throws:

NullPointerException - if some of the required fields are null.