Package org.opensearch.client.opensearch.core

Class UpdateByQueryResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.UpdateByQueryResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

UpdateByQueryResponse

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

Builder for UpdateByQueryResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

batches

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

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

API name: batches

canceled

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

API name: canceled

created

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

The number of documents that were successfully created.

API name: created

deleted

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

The number of documents that were successfully deleted.

API name: deleted

failures

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

The list of failures that occurred during the operation.

API name: failures

Adds all elements of list to failures.

failures

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

The list of failures that occurred during the operation.

API name: failures

Adds one or more values to failures.

failures

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

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 UpdateByQueryResponse.Builder noops(@Nullable
 Long value)

The number of documents that were ignored.

API name: noops

requestsPerSecond

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

API name: retries

retries

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

API name: retries

sliceId

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

API name: slice_id

slices

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

API name: slices

Adds all elements of list to slices.

slices

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

API name: slices

Adds one or more values to slices.

slices

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

API name: slices

Adds a value to slices using a builder lambda.

task

@Nonnull
public final UpdateByQueryResponse.Builder task(@Nullable
 String value)

API name: task

throttled

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

API name: throttled

throttled

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

API name: throttled

throttledMillis

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

API name: throttled_millis

throttledUntil

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

The amount time before the throttling will end.

API name: throttled_until

throttledUntil

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

The amount time before the throttling will end.

API name: throttled_until

throttledUntilMillis

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

When the throttling will end in milliseconds.

API name: throttled_until_millis

timedOut

@Nonnull
public final UpdateByQueryResponse.Builder timedOut(@Nullable
 Boolean value)

Whether the operation timed out.

API name: timed_out

took

@Nonnull
public final UpdateByQueryResponse.Builder took(@Nullable
 Long value)

The time taken by the operation in milliseconds.

API name: took

total

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

The number of documents that were successfully processed.

API name: total

updated

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

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

API name: updated

versionConflicts

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

The number of version conflicts encountered by the reindex operation.

API name: version_conflicts

build

@Nonnull
public UpdateByQueryResponse build()

Builds a UpdateByQueryResponse.

Specified by:

build in interface ObjectBuilder<UpdateByQueryResponse>

Throws:

NullPointerException - if some of the required fields are null.