Package org.opensearch.client.opensearch.core

Class UpdateByQueryResponse

java.lang.Object

org.opensearch.client.opensearch.core.UpdateByQueryResponse

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class UpdateByQueryResponse
extends java.lang.Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateByQueryResponse.Builder	Builder for UpdateByQueryResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<UpdateByQueryResponse>	_DESERIALIZER	Json deserializer for UpdateByQueryResponse

Method Summary

Modifier and Type	Method	Description
java.lang.Long	batches()	API name: batches
java.lang.Long	deleted()	API name: deleted
java.util.List<BulkIndexByScrollFailure>	failures()	API name: failures
java.lang.Long	noops()	API name: noops
static UpdateByQueryResponse	of(java.util.function.Function<UpdateByQueryResponse.Builder,ObjectBuilder<UpdateByQueryResponse>> fn)
java.lang.Float	requestsPerSecond()	API name: requests_per_second
Retries	retries()	API name: retries
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupUpdateByQueryResponseDeserializer(ObjectDeserializer<UpdateByQueryResponse.Builder> op)
java.lang.String	task()	API name: task
java.lang.Number	throttledMillis()	API name: throttled_millis
java.lang.Number	throttledUntilMillis()	API name: throttled_until_millis
java.lang.Boolean	timedOut()	API name: timed_out
java.lang.Long	took()	API name: took
java.lang.Long	total()	API name: total
java.lang.Long	updated()	API name: updated
java.lang.Long	versionConflicts()	API name: version_conflicts

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<UpdateByQueryResponse> _DESERIALIZER

Json deserializer for UpdateByQueryResponse

Method Detail

of

public static UpdateByQueryResponse of(java.util.function.Function<UpdateByQueryResponse.Builder,ObjectBuilder<UpdateByQueryResponse>> fn)

batches

@Nullable
public final java.lang.Long batches()

API name: batches

failures

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

API name: failures

noops

@Nullable
public final java.lang.Long noops()

API name: noops

deleted

@Nullable
public final java.lang.Long deleted()

API name: deleted

requestsPerSecond

@Nullable
public final java.lang.Float requestsPerSecond()

API name: requests_per_second

retries

@Nullable
public final Retries retries()

API name: retries

task

@Nullable
public final java.lang.String task()

API name: task

timedOut

@Nullable
public final java.lang.Boolean timedOut()

API name: timed_out

took

@Nullable
public final java.lang.Long took()

API name: took

total

@Nullable
public final java.lang.Long total()

API name: total

updated

@Nullable
public final java.lang.Long updated()

API name: updated

versionConflicts

@Nullable
public final java.lang.Long versionConflicts()

API name: version_conflicts

throttledMillis

@Nullable
public final java.lang.Number throttledMillis()

API name: throttled_millis

throttledUntilMillis

@Nullable
public final java.lang.Number throttledUntilMillis()

API name: throttled_until_millis

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupUpdateByQueryResponseDeserializer

protected static void setupUpdateByQueryResponseDeserializer(ObjectDeserializer<UpdateByQueryResponse.Builder> op)