Package org.opensearch.client.opensearch.tasks

Class TaskResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.tasks.TaskResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

TaskResponse

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

Builder for TaskResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

batches

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

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

API name: batches

canceled

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

API name: canceled

created

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

The number of documents that were successfully created.

API name: created

deleted

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

Required - The number of documents that were successfully deleted.

API name: deleted

failures

@Nonnull
public final TaskResponse.Builder failures(List<BulkByScrollFailure> list)

Required - The list of failures that occurred during the operation.

API name: failures

Adds all elements of list to failures.

failures

@Nonnull
public final TaskResponse.Builder failures(BulkByScrollFailure value,
 BulkByScrollFailure... values)

Required - The list of failures that occurred during the operation.

API name: failures

Adds one or more values to failures.

failures

@Nonnull
public final TaskResponse.Builder failures(Function<BulkByScrollFailure.Builder,ObjectBuilder<BulkByScrollFailure>> fn)

Required - The list of failures that occurred during the operation.

API name: failures

Adds a value to failures using a builder lambda.

noops

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

Required - The number of documents that were ignored.

API name: noops

requestsPerSecond

@Nonnull
public final TaskResponse.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 TaskResponse.Builder retries(Retries value)

Required - API name: retries

retries

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

Required - API name: retries

sliceId

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

API name: slice_id

slices

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

API name: slices

Adds all elements of list to slices.

slices

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

API name: slices

Adds one or more values to slices.

slices

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

API name: slices

Adds a value to slices using a builder lambda.

throttled

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

API name: throttled

throttled

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

API name: throttled

throttledMillis

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

Required - API name: throttled_millis

throttledUntil

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

The amount time before the throttling will end.

API name: throttled_until

throttledUntil

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

The amount time before the throttling will end.

API name: throttled_until

throttledUntilMillis

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

Required - When the throttling will end in milliseconds.

API name: throttled_until_millis

timedOut

@Nonnull
public final TaskResponse.Builder timedOut(boolean value)

Required - Whether the operation timed out.

API name: timed_out

took

@Nonnull
public final TaskResponse.Builder took(long value)

Required - The time taken by the operation in milliseconds.

API name: took

total

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

Required - The number of documents that were successfully processed.

API name: total

updated

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

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

API name: updated

versionConflicts

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

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

API name: version_conflicts

build

@Nonnull
public TaskResponse build()

Builds a TaskResponse.

Specified by:

build in interface ObjectBuilder<TaskResponse>

Throws:

NullPointerException - if some of the required fields are null.