Package org.opensearch.client.opensearch.tasks

Class Status.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.tasks.Status.Builder

All Implemented Interfaces:

ObjectBuilder<Status>

Enclosing class:

Status

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

Builder for Status.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Status.Builder	batches(long value)	Required - API name: batches
Status	build()	Builds a Status.
Status.Builder	canceled(java.lang.String value)	API name: canceled
Status.Builder	created(long value)	Required - API name: created
Status.Builder	deleted(long value)	Required - API name: deleted
Status.Builder	failures(java.lang.String value, java.lang.String... values)	API name: failures
Status.Builder	failures(java.util.List<java.lang.String> list)	API name: failures
Status.Builder	noops(long value)	Required - API name: noops
Status.Builder	requestsPerSecond(float value)	Required - API name: requests_per_second
Status.Builder	retries(java.util.function.Function<Retries.Builder,ObjectBuilder<Retries>> fn)	Required - API name: retries
Status.Builder	retries(Retries value)	Required - API name: retries
Status.Builder	throttled(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: throttled
Status.Builder	throttled(Time value)	API name: throttled
Status.Builder	throttledMillis(long value)	Required - API name: throttled_millis
Status.Builder	throttledUntil(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: throttled_until
Status.Builder	throttledUntil(Time value)	API name: throttled_until
Status.Builder	throttledUntilMillis(long value)	Required - API name: throttled_until_millis
Status.Builder	timedOut(java.lang.Boolean value)	API name: timed_out
Status.Builder	took(java.lang.Long value)	API name: took
Status.Builder	total(long value)	Required - API name: total
Status.Builder	updated(long value)	Required - API name: updated
Status.Builder	versionConflicts(long value)	Required - 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 Status.Builder batches(long value)

Required - API name: batches

canceled

public final Status.Builder canceled(@Nullable
                                     java.lang.String value)

API name: canceled

created

public final Status.Builder created(long value)

Required - API name: created

deleted

public final Status.Builder deleted(long value)

Required - API name: deleted

noops

public final Status.Builder noops(long value)

Required - API name: noops

failures

public final Status.Builder failures(java.util.List<java.lang.String> list)

API name: failures

Adds all elements of list to failures.

failures

public final Status.Builder failures(java.lang.String value,
                                     java.lang.String... values)

API name: failures

Adds one or more values to failures.

requestsPerSecond

public final Status.Builder requestsPerSecond(float value)

Required - API name: requests_per_second

retries

public final Status.Builder retries(Retries value)

Required - API name: retries

retries

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

Required - API name: retries

throttled

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

API name: throttled

throttled

public final Status.Builder throttled(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: throttled

throttledMillis

public final Status.Builder throttledMillis(long value)

Required - API name: throttled_millis

throttledUntil

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

API name: throttled_until

throttledUntil

public final Status.Builder throttledUntil(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: throttled_until

throttledUntilMillis

public final Status.Builder throttledUntilMillis(long value)

Required - API name: throttled_until_millis

timedOut

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

API name: timed_out

took

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

API name: took

total

public final Status.Builder total(long value)

Required - API name: total

updated

public final Status.Builder updated(long value)

Required - API name: updated

versionConflicts

public final Status.Builder versionConflicts(long value)

Required - API name: version_conflicts

build

public Status build()

Builds a Status.

Specified by:

build in interface ObjectBuilder<Status>

Throws:

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