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:

ObjectBuilder<UpdateByQueryResponse>

Enclosing class:

UpdateByQueryResponse

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

Builder for UpdateByQueryResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateByQueryResponse.Builder	batches(java.lang.Long value)	API name: batches
UpdateByQueryResponse	build()	Builds a UpdateByQueryResponse.
UpdateByQueryResponse.Builder	deleted(java.lang.Long value)	API name: deleted
UpdateByQueryResponse.Builder	failures(java.util.function.Function<BulkIndexByScrollFailure.Builder,ObjectBuilder<BulkIndexByScrollFailure>> fn)	API name: failures
UpdateByQueryResponse.Builder	failures(java.util.List<BulkIndexByScrollFailure> list)	API name: failures
UpdateByQueryResponse.Builder	failures(BulkIndexByScrollFailure value, BulkIndexByScrollFailure... values)	API name: failures
UpdateByQueryResponse.Builder	noops(java.lang.Long value)	API name: noops
UpdateByQueryResponse.Builder	requestsPerSecond(java.lang.Float value)	API name: requests_per_second
UpdateByQueryResponse.Builder	retries(java.util.function.Function<Retries.Builder,ObjectBuilder<Retries>> fn)	API name: retries
UpdateByQueryResponse.Builder	retries(Retries value)	API name: retries
UpdateByQueryResponse.Builder	task(java.lang.String value)	API name: task
UpdateByQueryResponse.Builder	throttledMillis(java.lang.Number value)	API name: throttled_millis
UpdateByQueryResponse.Builder	throttledUntilMillis(java.lang.Number value)	API name: throttled_until_millis
UpdateByQueryResponse.Builder	timedOut(java.lang.Boolean value)	API name: timed_out
UpdateByQueryResponse.Builder	took(java.lang.Long value)	API name: took
UpdateByQueryResponse.Builder	total(java.lang.Long value)	API name: total
UpdateByQueryResponse.Builder	updated(java.lang.Long value)	API name: updated
UpdateByQueryResponse.Builder	versionConflicts(java.lang.Long value)	API name: version_conflicts

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

batches

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

API name: batches

failures

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

API name: failures

Adds all elements of list to failures.

failures

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

API name: failures

Adds one or more values to failures.

failures

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

API name: failures

Adds a value to failures using a builder lambda.

noops

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

API name: noops

deleted

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

API name: deleted

requestsPerSecond

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

API name: requests_per_second

retries

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

API name: retries

retries

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

API name: retries

task

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

API name: task

timedOut

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

API name: timed_out

took

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

API name: took

total

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

API name: total

updated

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

API name: updated

versionConflicts

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

API name: version_conflicts

throttledMillis

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

API name: throttled_millis

throttledUntilMillis

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

API name: throttled_until_millis

build

public UpdateByQueryResponse build()

Builds a UpdateByQueryResponse.

Specified by:

build in interface ObjectBuilder<UpdateByQueryResponse>

Throws:

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