Package org.opensearch.client.opensearch.tasks

Class TaskResponse

java.lang.Object
org.opensearch.client.opensearch.tasks.TaskResponse
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<TaskResponse.Builder,TaskResponse>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class TaskResponse extends Object implements PlainJsonSerializable, ToCopyableBuilder<TaskResponse.Builder,TaskResponse>

  • Field Details

  • Method Details

    • of

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

    • batches

      public final int batches()
      Required - The number of scroll responses pulled back by the reindex operation.

      API name: batches

    • canceled

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

    • created

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

      API name: created

    • deleted

      public final long deleted()
      Required - The number of documents that were successfully deleted.

      API name: deleted

    • failures

      @Nonnull public final List<BulkByScrollFailure> failures()
      Required - The list of failures that occurred during the operation.

      API name: failures

    • noops

      public final long noops()
      Required - The number of documents that were ignored.

      API name: noops

    • requestsPerSecond

      public final float requestsPerSecond()
      Required - The number of requests per second effectively executed during the reindex operation.

      API name: requests_per_second

    • retries

      @Nonnull public final Retries retries()
      Required - API name: retries

    • sliceId

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

    • slices

      @Nonnull public final List<BulkByScrollTaskStatusOrException> slices()
      API name: slices

    • throttled

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

    • throttledMillis

      public final long throttledMillis()
      Required - API name: throttled_millis

    • throttledUntil

      @Nullable public final Time throttledUntil()
      The amount time before the throttling will end.

      API name: throttled_until

    • throttledUntilMillis

      public final long throttledUntilMillis()
      Required - When the throttling will end in milliseconds.

      API name: throttled_until_millis

    • timedOut

      public final boolean timedOut()
      Required - Whether the operation timed out.

      API name: timed_out

    • took

      public final long took()
      Required - The time taken by the operation in milliseconds.

      API name: took

    • total

      public final long total()
      Required - 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 after the reindex operation.

      API name: updated

    • versionConflicts

      public final long versionConflicts()
      Required - The number of version conflicts encountered by the reindex operation.

      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)

    • toBuilder

      @Nonnull public TaskResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TaskResponse.Builder,TaskResponse>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static TaskResponse.Builder builder()

    • setupTaskResponseDeserializer

      protected static void setupTaskResponseDeserializer(ObjectDeserializer<TaskResponse.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object