Class AsyncJobStatus

java.lang.Object
com.kingsrook.qqq.backend.core.actions.async.AsyncJobStatus
All Implemented Interfaces:
Serializable
public class AsyncJobStatus extends Object implements Serializable
Object to track current status of an async job - e.g., its state, and some messages from the backend like "x of y"
See Also:

  • Constructor Details

    • AsyncJobStatus

      public AsyncJobStatus()

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getState

      public AsyncJobState getState()
      Getter for state

    • setState

      public void setState(AsyncJobState state)
      Setter for state

    • getMessage

      public String getMessage()
      Getter for message

    • setMessage

      public void setMessage(String message)
      Setter for message

    • getCurrent

      public Integer getCurrent()
      Getter for current

    • setCurrent

      public void setCurrent(Integer current)
      Setter for current

    • getTotal

      public Integer getTotal()
      Getter for total

    • setTotal

      public void setTotal(Integer total)
      Setter for total

    • getCaughtException

      public Exception getCaughtException()
      Getter for caughtException

    • setCaughtException

      public void setCaughtException(Exception caughtException)
      Setter for caughtException

    • getCancelRequested

      public boolean getCancelRequested()
      Getter for cancelRequested

    • setCancelRequested

      public void setCancelRequested(boolean cancelRequested)
      Setter for cancelRequested

    • getJobName

      public String getJobName()
      Getter for jobName

    • setJobName

      public void setJobName(String jobName)
      Setter for jobName

    • withJobName

      public AsyncJobStatus withJobName(String jobName)
      Fluent setter for jobName

    • getStateAccess

      public ProcessStateAccess getStateAccess()
      Server-owned authorization, never part of an HTTP state response.

    • setStateAccess

      public void setStateAccess(ProcessStateAccess stateAccess)

    • getProgress

      public JobProgressSnapshot getProgress()
      Getter for progress

    • setProgress

      public void setProgress(JobProgressSnapshot progress)
      Setter for progress

    • withProgress

      public AsyncJobStatus withProgress(JobProgressSnapshot progress)
      Fluent setter for progress

    • getLogTail

      public List<JobLogLine> getLogTail()
      Getter for logTail

    • setLogTail

      public void setLogTail(List<JobLogLine> logTail)
      Setter for logTail

    • withLogTail

      public AsyncJobStatus withLogTail(List<JobLogLine> logTail)
      Fluent setter for logTail