Package co.elastic.clients.elasticsearch.core

Class DeleteByQueryResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.core.DeleteByQueryResponse.Builder

All Implemented Interfaces:

WithJson<DeleteByQueryResponse.Builder>, ObjectBuilder<DeleteByQueryResponse>

Enclosing class:

DeleteByQueryResponse

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

Builder for DeleteByQueryResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

API name: batches

deleted

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

The number of documents that were successfully deleted.

API name: deleted

failures

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

An array of failures if there were any unrecoverable errors during the process. If this array is not empty, the request ended abnormally because of those failures. Delete by query is implemented using batches and any failures cause 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 on version conflicts.

API name: failures

Adds all elements of list to failures.

failures

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

An array of failures if there were any unrecoverable errors during the process. If this array is not empty, the request ended abnormally because of those failures. Delete by query is implemented using batches and any failures cause 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 on version conflicts.

API name: failures

Adds one or more values to failures.

failures

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

An array of failures if there were any unrecoverable errors during the process. If this array is not empty, the request ended abnormally because of those failures. Delete by query is implemented using batches and any failures cause 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 on version conflicts.

API name: failures

Adds a value to failures using a builder lambda.

noops

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

This field is always equal to zero for delete by query. It exists only so that delete by query, update by query, and reindex APIs return responses with the same structure.

API name: noops

requestsPerSecond

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

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

API name: requests_per_second

retries

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

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

API name: retries

retries

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

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

API name: retries

sliceId

public final DeleteByQueryResponse.Builder sliceId(@Nullable
 Integer value)

API name: slice_id

task

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

API name: task

throttled

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

API name: throttled

throttled

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

API name: throttled

throttledMillis

public final DeleteByQueryResponse.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 DeleteByQueryResponse.Builder throttledUntil(@Nullable
 Time value)

API name: throttled_until

throttledUntil

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

API name: throttled_until

throttledUntilMillis

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

This field should always be equal to zero in a _delete_by_query response. It has meaning only 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

timedOut

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

If true, some requests run during the delete by query operation timed out.

API name: timed_out

took

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

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

API name: took

total

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

The number of documents that were successfully processed.

API name: total

versionConflicts

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

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

API name: version_conflicts

self

protected DeleteByQueryResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<DeleteByQueryResponse.Builder>

build

public DeleteByQueryResponse build()

Builds a DeleteByQueryResponse.

Specified by:

build in interface ObjectBuilder<DeleteByQueryResponse>

Throws:

NullPointerException - if some of the required fields are null.