Package co.elastic.clients.elasticsearch.tasks

Class TaskInfo.AbstractBuilder<BuilderT extends TaskInfo.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.tasks.TaskInfo.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
ParentTaskInfo.Builder, TaskInfo.Builder
Enclosing class:
TaskInfo
public abstract static class TaskInfo.AbstractBuilder<BuilderT extends TaskInfo.AbstractBuilder<BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • action

      public final BuilderT action(String value)
      Required - API name: action

    • cancelled

      public final BuilderT cancelled(@Nullable Boolean value)
      API name: cancelled

    • cancellable

      public final BuilderT cancellable(boolean value)
      Required - API name: cancellable

    • description

      public final BuilderT description(@Nullable String value)
      Human readable text that identifies the particular request that the task is performing. For example, it might identify the search request being performed by a search task. Other kinds of tasks have different descriptions, like _reindex which has the source and the destination, or _bulk which just has the number of requests and the destination indices. Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.

      API name: description

    • headers

      public final BuilderT headers(Map<String,String> map)
      Required - API name: headers

      Adds all entries of map to headers.

    • headers

      public final BuilderT headers(String key, String value)
      Required - API name: headers

      Adds an entry to headers.

    • id

      public final BuilderT id(long value)
      Required - API name: id

    • node

      public final BuilderT node(String value)
      Required - API name: node

    • runningTime

      public final BuilderT runningTime(@Nullable Time value)
      API name: running_time

    • runningTime

      public final BuilderT runningTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      API name: running_time

    • runningTimeInNanos

      public final BuilderT runningTimeInNanos(long value)
      Required - API name: running_time_in_nanos

    • startTimeInMillis

      public final BuilderT startTimeInMillis(long value)
      Required - API name: start_time_in_millis

    • status

      public final BuilderT status(@Nullable JsonData value)
      The internal status of the task, which varies from task to task. The format also varies. While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.

      API name: status

    • type

      public final BuilderT type(String value)
      Required - API name: type

    • parentTaskId

      public final BuilderT parentTaskId(@Nullable String value)
      API name: parent_task_id

    • originalTaskId

      public final BuilderT originalTaskId(@Nullable String value)
      The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task). For tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response.

      API name: original_task_id

    • originalStartTimeInMillis

      public final BuilderT originalStartTimeInMillis(@Nullable Long value)
      The time at which the original task started, in milliseconds since the Unix epoch. Only present together with original_task_id.

      API name: original_start_time_in_millis

    • originalStartTime

      public final BuilderT originalStartTime(@Nullable String value)
      The time at which the original task started, as an ISO 8601 formatted string. Only present together with original_task_id and when the request includes the ?human=true query parameter.

      API name: original_start_time

    • self

      protected abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends TaskInfo.AbstractBuilder<BuilderT>>