Class TaskStatusValueObject

java.lang.Object
ubic.gemma.rest.TaskStatusValueObject
public class TaskStatusValueObject extends Object
Snapshot of a SubmittedTask for the REST API.

Returned by the dispatch endpoints (with HTTP 202 + a Location header) and by GET /tasks/{taskId}. The underlying task store is in-memory only and tasks are evicted roughly 10 minutes after completion, so GET /tasks/{taskId} returns 404 once the window elapses.

  • Constructor Details

    • TaskStatusValueObject

      public TaskStatusValueObject()

    • TaskStatusValueObject

      public TaskStatusValueObject(SubmittedTask task)

  • Method Details

    • getTaskId

      public String getTaskId()

    • getExperimentId

      @Nullable public Long getExperimentId()
      Identifier of the experiment the task is operating on, when derivable from the task command.

    • getStep

      @Nullable public String getStep()
      Pipeline step the task corresponds to: preprocess, pca, batchInfo, dea, deaRemove. null for tasks whose command class isn't a known pipeline command.

    • getStatus

      public String getStatus()
      Lower-cased SubmittedTask.Status value: queued, running, completed, failed, cancelling, unknown.

    • getSubmittedAt

      @Nullable public Date getSubmittedAt()

    • getStartedAt

      @Nullable public Date getStartedAt()

    • getCompletedAt

      @Nullable public Date getCompletedAt()

    • getMessage

      public String getMessage()
      Last progress update emitted by the task. Empty string when nothing is available.

    • getError

      @Nullable public TaskStatusValueObject.TaskError getError()
      Structured failure detail. Non-null exactly when status is failed; null otherwise. Lets a client distinguish (and act on) the many ways an import/pipeline task can go wrong — a network hiccup, an accession that already exists, an invalid accession, a super-series gate, etc. — instead of seeing an opaque failed.

    • setTaskId

      public void setTaskId(String taskId)

    • setExperimentId

      public void setExperimentId(@Nullable Long experimentId)
      Identifier of the experiment the task is operating on, when derivable from the task command.

    • setStep

      public void setStep(@Nullable String step)
      Pipeline step the task corresponds to: preprocess, pca, batchInfo, dea, deaRemove. null for tasks whose command class isn't a known pipeline command.

    • setStatus

      public void setStatus(String status)
      Lower-cased SubmittedTask.Status value: queued, running, completed, failed, cancelling, unknown.

    • setSubmittedAt

      public void setSubmittedAt(@Nullable Date submittedAt)

    • setStartedAt

      public void setStartedAt(@Nullable Date startedAt)

    • setCompletedAt

      public void setCompletedAt(@Nullable Date completedAt)

    • setMessage

      public void setMessage(String message)
      Last progress update emitted by the task. Empty string when nothing is available.

    • setError

      public void setError(@Nullable TaskStatusValueObject.TaskError error)
      Structured failure detail. Non-null exactly when status is failed; null otherwise. Lets a client distinguish (and act on) the many ways an import/pipeline task can go wrong — a network hiccup, an accession that already exists, an invalid accession, a super-series gate, etc. — instead of seeing an opaque failed.