Package org.opensearch.client.opensearch._global

Class DeleteByQueryResponse.Builder

java.lang.Object

org.opensearch.client.opensearch._global.DeleteByQueryResponse.Builder

All Implemented Interfaces:

ObjectBuilder<DeleteByQueryResponse>

Enclosing class:

DeleteByQueryResponse

public static class DeleteByQueryResponse.Builder
extends java.lang.Object
implements ObjectBuilder<DeleteByQueryResponse>

Builder for DeleteByQueryResponse.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeleteByQueryResponse.Builder	addFailures(java.util.function.Function<BulkIndexByScrollFailure.Builder,ObjectBuilder<BulkIndexByScrollFailure>> fn)	Add a value to failures(List), creating the list if needed.
DeleteByQueryResponse.Builder	addFailures(BulkIndexByScrollFailure value)	Add a value to failures(List), creating the list if needed.
DeleteByQueryResponse.Builder	batches(java.lang.Number value)	API name: batches
DeleteByQueryResponse	build()	Builds a DeleteByQueryResponse.
DeleteByQueryResponse.Builder	deleted(java.lang.Number value)	API name: deleted
DeleteByQueryResponse.Builder	failures(java.util.function.Function<BulkIndexByScrollFailure.Builder,ObjectBuilder<BulkIndexByScrollFailure>> fn)	Set failures(List) to a singleton list.
DeleteByQueryResponse.Builder	failures(java.util.List<BulkIndexByScrollFailure> value)	API name: failures
DeleteByQueryResponse.Builder	failures(BulkIndexByScrollFailure... value)	API name: failures
DeleteByQueryResponse.Builder	noops(java.lang.Number value)	API name: noops
DeleteByQueryResponse.Builder	requestsPerSecond(java.lang.Number value)	API name: requests_per_second
DeleteByQueryResponse.Builder	retries(java.util.function.Function<Retries.Builder,ObjectBuilder<Retries>> fn)	API name: retries
DeleteByQueryResponse.Builder	retries(Retries value)	API name: retries
DeleteByQueryResponse.Builder	sliceId(java.lang.Number value)	API name: slice_id
DeleteByQueryResponse.Builder	task(jakarta.json.JsonValue value)	API name: task
DeleteByQueryResponse.Builder	throttledMillis(java.lang.Number value)	API name: throttled_millis
DeleteByQueryResponse.Builder	throttledUntilMillis(java.lang.Number value)	API name: throttled_until_millis
DeleteByQueryResponse.Builder	timedOut(java.lang.Boolean value)	API name: timed_out
DeleteByQueryResponse.Builder	took(java.lang.Number value)	API name: took
DeleteByQueryResponse.Builder	total(java.lang.Number value)	API name: total
DeleteByQueryResponse.Builder	versionConflicts(java.lang.Number value)	API name: version_conflicts

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

batches

public DeleteByQueryResponse.Builder batches(@Nullable java.lang.Number value)

API name: batches

deleted

public DeleteByQueryResponse.Builder deleted(@Nullable java.lang.Number value)

API name: deleted

failures

public DeleteByQueryResponse.Builder failures(@Nullable java.util.List<BulkIndexByScrollFailure> value)

API name: failures

failures

public DeleteByQueryResponse.Builder failures(BulkIndexByScrollFailure... value)

API name: failures

addFailures

public DeleteByQueryResponse.Builder addFailures(BulkIndexByScrollFailure value)

Add a value to failures(List), creating the list if needed.

failures

public DeleteByQueryResponse.Builder failures(java.util.function.Function<BulkIndexByScrollFailure.Builder,ObjectBuilder<BulkIndexByScrollFailure>> fn)

Set failures(List) to a singleton list.

addFailures

public DeleteByQueryResponse.Builder addFailures(java.util.function.Function<BulkIndexByScrollFailure.Builder,ObjectBuilder<BulkIndexByScrollFailure>> fn)

Add a value to failures(List), creating the list if needed.

noops

public DeleteByQueryResponse.Builder noops(@Nullable java.lang.Number value)

API name: noops

requestsPerSecond

public DeleteByQueryResponse.Builder requestsPerSecond(@Nullable java.lang.Number value)

API name: requests_per_second

retries

public DeleteByQueryResponse.Builder retries(@Nullable Retries value)

API name: retries

retries

public DeleteByQueryResponse.Builder retries(java.util.function.Function<Retries.Builder,ObjectBuilder<Retries>> fn)

API name: retries

sliceId

public DeleteByQueryResponse.Builder sliceId(@Nullable java.lang.Number value)

API name: slice_id

task

public DeleteByQueryResponse.Builder task(@Nullable jakarta.json.JsonValue value)

API name: task

throttledMillis

public DeleteByQueryResponse.Builder throttledMillis(@Nullable java.lang.Number value)

API name: throttled_millis

throttledUntilMillis

public DeleteByQueryResponse.Builder throttledUntilMillis(@Nullable java.lang.Number value)

API name: throttled_until_millis

timedOut

public DeleteByQueryResponse.Builder timedOut(@Nullable java.lang.Boolean value)

API name: timed_out

took

public DeleteByQueryResponse.Builder took(@Nullable java.lang.Number value)

API name: took

total

public DeleteByQueryResponse.Builder total(@Nullable java.lang.Number value)

API name: total

versionConflicts

public DeleteByQueryResponse.Builder versionConflicts(@Nullable java.lang.Number value)

API name: version_conflicts

build

public DeleteByQueryResponse build()

Builds a DeleteByQueryResponse.

Specified by:

build in interface ObjectBuilder<DeleteByQueryResponse>

Throws:

java.lang.NullPointerException - if some of the required fields are null.