Package co.elastic.clients.elasticsearch.core

Class UpdateByQueryResponse

java.lang.Object
co.elastic.clients.elasticsearch.core.UpdateByQueryResponse
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class UpdateByQueryResponse extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • batches

      @Nullable public final Long batches()
      The number of scroll responses pulled back by the update by query.

      API name: batches

    • failures

      public final List<BulkIndexByScrollFailure> failures()
      Array of failures if there were any unrecoverable errors during the process. If this is non-empty then the request ended because of those failures. Update by query is implemented using batches. Any failure causes 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 when version conflicts occur.

      API name: failures

    • noops

      @Nullable public final Long noops()
      The number of documents that were ignored because the script used for the update by query returned a noop value for ctx.op.

      API name: noops

    • deleted

      @Nullable public final Long deleted()
      The number of documents that were successfully deleted.

      API name: deleted

    • requestsPerSecond

      @Nullable public final Float requestsPerSecond()
      The number of requests per second effectively run during the update by query.

      API name: requests_per_second

    • retries

      @Nullable public final Retries retries()
      The number of retries attempted by update by query. bulk is the number of bulk actions retried. search is the number of search actions retried.

      API name: retries

    • task

      @Nullable public final String task()
      API name: task

    • timedOut

      @Nullable public final Boolean timedOut()
      If true, some requests timed out during the update by query.

      API name: timed_out

    • took

      @Nullable public final Long took()
      The number of milliseconds from start to end of the whole operation.

      API name: took

    • total

      @Nullable public final Long total()
      The number of documents that were successfully processed.

      API name: total

    • updated

      @Nullable public final Long updated()
      The number of documents that were successfully updated.

      API name: updated

    • versionConflicts

      @Nullable public final Long versionConflicts()
      The number of version conflicts that the update by query hit.

      API name: version_conflicts

    • throttled

      @Nullable public final Time throttled()
      API name: throttled

    • throttledMillis

      @Nullable public final Long throttledMillis()
      The number of milliseconds the request slept to conform to requests_per_second.

      API name: throttled_millis

    • throttledUntil

      @Nullable public final Time throttledUntil()
      API name: throttled_until

    • throttledUntilMillis

      @Nullable public final Long throttledUntilMillis()
      This field should always be equal to zero in an _update_by_query response. It only has meaning 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

    • 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)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupUpdateByQueryResponseDeserializer

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