Package co.elastic.clients.elasticsearch.core

Class DeleteByQueryResponse

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

  • Field Details

  • Method Details

    • of

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

    • batches

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

      API name: batches

    • deleted

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

      API name: deleted

    • failures

      public final List<BulkIndexByScrollFailure> failures()
      An array of failures if there were any unrecoverable errors during the process. If this array is not empty, the request ended abnormally because of those failures. Delete by query is implemented using batches and any failures cause 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 on version conflicts.

      API name: failures

    • noops

      @Nullable public final Long noops()
      This field is always equal to zero for delete by query. It exists only so that delete by query, update by query, and reindex APIs return responses with the same structure.

      API name: noops

    • requestsPerSecond

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

      API name: requests_per_second

    • retries

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

      API name: retries

    • sliceId

      @Nullable public final Integer sliceId()
      API name: slice_id

    • task

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

    • 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 a _delete_by_query response. It has meaning only 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

    • timedOut

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

      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

    • versionConflicts

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

      API name: version_conflicts

    • 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

    • setupDeleteByQueryResponseDeserializer

      protected static void setupDeleteByQueryResponseDeserializer(ObjectDeserializer<DeleteByQueryResponse.Builder> op)