Package co.elastic.clients.elasticsearch.core

Class UpdateByQueryResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<UpdateByQueryResponse.Builder>

co.elastic.clients.elasticsearch.core.UpdateByQueryResponse.Builder

All Implemented Interfaces:

WithJson<UpdateByQueryResponse.Builder>, ObjectBuilder<UpdateByQueryResponse>

Enclosing class:

UpdateByQueryResponse

public static class UpdateByQueryResponse.Builder
extends WithJsonObjectBuilderBase<UpdateByQueryResponse.Builder>
implements ObjectBuilder<UpdateByQueryResponse>

Builder for UpdateByQueryResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final UpdateByQueryResponse.Builder	batches(Long value)	The number of scroll responses pulled back by the update by query.
UpdateByQueryResponse	build()	Builds a UpdateByQueryResponse.
final UpdateByQueryResponse.Builder	deleted(Long value)	The number of documents that were successfully deleted.
final UpdateByQueryResponse.Builder	failures(BulkIndexByScrollFailure value, BulkIndexByScrollFailure... values)	Array of failures if there were any unrecoverable errors during the process.
final UpdateByQueryResponse.Builder	failures(Function<BulkIndexByScrollFailure.Builder,ObjectBuilder<BulkIndexByScrollFailure>> fn)	Array of failures if there were any unrecoverable errors during the process.
final UpdateByQueryResponse.Builder	failures(List<BulkIndexByScrollFailure> list)	Array of failures if there were any unrecoverable errors during the process.
final UpdateByQueryResponse.Builder	noops(Long value)	The number of documents that were ignored because the script used for the update by query returned a noop value for ctx.op.
final UpdateByQueryResponse.Builder	requestsPerSecond(Float value)	The number of requests per second effectively run during the update by query.
final UpdateByQueryResponse.Builder	retries(Retries value)	The number of retries attempted by update by query.
final UpdateByQueryResponse.Builder	retries(Function<Retries.Builder,ObjectBuilder<Retries>> fn)	The number of retries attempted by update by query.
protected UpdateByQueryResponse.Builder	self()
final UpdateByQueryResponse.Builder	task(String value)	API name: task
final UpdateByQueryResponse.Builder	throttled(Time value)	API name: throttled
final UpdateByQueryResponse.Builder	throttled(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: throttled
final UpdateByQueryResponse.Builder	throttledMillis(Long value)	The number of milliseconds the request slept to conform to requests_per_second.
final UpdateByQueryResponse.Builder	throttledUntil(Time value)	API name: throttled_until
final UpdateByQueryResponse.Builder	throttledUntil(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: throttled_until
final UpdateByQueryResponse.Builder	throttledUntilMillis(Long value)	This field should always be equal to zero in an _update_by_query response.
final UpdateByQueryResponse.Builder	timedOut(Boolean value)	If true, some requests timed out during the update by query.
final UpdateByQueryResponse.Builder	took(Long value)	The number of milliseconds from start to end of the whole operation.
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.
final UpdateByQueryResponse.Builder	versionConflicts(Long value)	The number of version conflicts that the update by query hit.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

batches

public final UpdateByQueryResponse.Builder batches(@Nullable
 Long value)

The number of scroll responses pulled back by the update by query.

API name: batches

failures

public final UpdateByQueryResponse.Builder failures(List<BulkIndexByScrollFailure> list)

Array of failures if there were any unrecoverable errors during the process. If this is non-empty then the request ended because of those failures. Update by query is implemented using batches. Any failure causes the entire process to end, but all failures in the current batch are collected into the array. You can use the conflicts option to prevent reindex from ending when version conflicts occur.

API name: failures

Adds all elements of list to failures.

failures

public final UpdateByQueryResponse.Builder failures(BulkIndexByScrollFailure value,
 BulkIndexByScrollFailure... values)

Array of failures if there were any unrecoverable errors during the process. If this is non-empty then the request ended because of those failures. Update by query is implemented using batches. Any failure causes the entire process to end, but all failures in the current batch are collected into the array. You can use the conflicts option to prevent reindex from ending when version conflicts occur.

API name: failures

Adds one or more values to failures.

failures

public final UpdateByQueryResponse.Builder failures(Function<BulkIndexByScrollFailure.Builder,ObjectBuilder<BulkIndexByScrollFailure>> fn)

Array of failures if there were any unrecoverable errors during the process. If this is non-empty then the request ended because of those failures. Update by query is implemented using batches. Any failure causes the entire process to end, but all failures in the current batch are collected into the array. You can use the conflicts option to prevent reindex from ending when version conflicts occur.

API name: failures

Adds a value to failures using a builder lambda.

noops

public final UpdateByQueryResponse.Builder noops(@Nullable
 Long value)

The number of documents that were ignored because the script used for the update by query returned a noop value for ctx.op.

API name: noops

deleted

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

The number of documents that were successfully deleted.

API name: deleted

requestsPerSecond

public final UpdateByQueryResponse.Builder requestsPerSecond(@Nullable
 Float value)

The number of requests per second effectively run during the update by query.

API name: requests_per_second

retries

public final UpdateByQueryResponse.Builder retries(@Nullable
 Retries value)

The number of retries attempted by update by query. bulk is the number of bulk actions retried. search is the number of search actions retried.

API name: retries

retries

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

The number of retries attempted by update by query. bulk is the number of bulk actions retried. search is the number of search actions retried.

API name: retries

task

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

API name: task

timedOut

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

If true, some requests timed out during the update by query.

API name: timed_out

took

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

The number of milliseconds from start to end of the whole operation.

API name: took

total

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

The number of documents that were successfully processed.

API name: total

updated

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

The number of documents that were successfully updated.

API name: updated

versionConflicts

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

The number of version conflicts that the update by query hit.

API name: version_conflicts

throttled

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

API name: throttled

throttled

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

API name: throttled

throttledMillis

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

The number of milliseconds the request slept to conform to requests_per_second.

API name: throttled_millis

throttledUntil

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

API name: throttled_until

throttledUntil

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

API name: throttled_until

throttledUntilMillis

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

This field should always be equal to zero in an _update_by_query response. It only has meaning when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to requests_per_second.

API name: throttled_until_millis

self

protected UpdateByQueryResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<UpdateByQueryResponse.Builder>

build

public UpdateByQueryResponse build()

Builds a UpdateByQueryResponse.

Specified by:

build in interface ObjectBuilder<UpdateByQueryResponse>

Throws:

NullPointerException - if some of the required fields are null.