Class LaunchRequest

java.lang.Object
com.kingsrook.qqq.backend.core.jobs.model.LaunchRequest
public class LaunchRequest extends Object
A request to run a process as a durable job (DurableJobs.launch, and the body of POST /qqq/v1/processes/{processName}/jobs).

  • Constructor Details

    • LaunchRequest

      public LaunchRequest()
      Constructor

    • LaunchRequest

      public LaunchRequest(String processName)
      Constructor

  • Method Details

    • getProcessName

      public String getProcessName()
      Getter for processName

    • withProcessName

      public LaunchRequest withProcessName(String processName)
      Fluent setter for processName

    • getValues

      public Map<String,Serializable> getValues()
      Getter for values

    • withValues

      public LaunchRequest withValues(Map<String,Serializable> values)
      Fluent setter for values

    • withValue

      public LaunchRequest withValue(String name, Serializable value)
      Fluent setter for one value

    • getFilter

      public QQueryFilter getFilter()
      Getter for filter

    • withFilter

      public LaunchRequest withFilter(QQueryFilter filter)
      Fluent setter for filter

    • getRecordIds

      public List<Serializable> getRecordIds()
      Getter for recordIds

    • withRecordIds

      public LaunchRequest withRecordIds(List<Serializable> recordIds)
      Fluent setter for recordIds

    • getUploadRefs

      public List<String> getUploadRefs()
      Getter for uploadRefs

    • withUploadRefs

      public LaunchRequest withUploadRefs(List<String> uploadRefs)
      Fluent setter for uploadRefs

    • getSavedBulkLoadProfileId

      public Integer getSavedBulkLoadProfileId()
      Getter for savedBulkLoadProfileId

    • withSavedBulkLoadProfileId

      public LaunchRequest withSavedBulkLoadProfileId(Integer savedBulkLoadProfileId)
      Fluent setter for savedBulkLoadProfileId

    • getProfileJson

      public String getProfileJson()
      Getter for profileJson

    • withProfileJson

      public LaunchRequest withProfileJson(String profileJson)
      Fluent setter for profileJson

    • getMode

      public JobMode getMode()
      Getter for mode

    • withMode

      public LaunchRequest withMode(JobMode mode)
      Fluent setter for mode

    • getPriority

      public Integer getPriority()
      Getter for priority

    • withPriority

      public LaunchRequest withPriority(Integer priority)
      Fluent setter for priority

    • getNotifyEmail

      public Boolean getNotifyEmail()
      Getter for notifyEmail

    • withNotifyEmail

      public LaunchRequest withNotifyEmail(Boolean notifyEmail)
      Fluent setter for notifyEmail

    • getLabel

      public String getLabel()
      Getter for label

    • withLabel

      public LaunchRequest withLabel(String label)
      Fluent setter for label

    • getStartAfterStep

      public String getStartAfterStep()
      Getter for startAfterStep: the launch point (frontend values collected up to here); backend steps after it run in the job.

    • withStartAfterStep

      public LaunchRequest withStartAfterStep(String startAfterStep)
      Fluent setter for startAfterStep

    • getParentJobId

      public Integer getParentJobId()
      Getter for parentJobId (retry or run-again of)

    • withParentJobId

      public LaunchRequest withParentJobId(Integer parentJobId)
      Fluent setter for parentJobId

    • getExpectedRows

      public Long getExpectedRows()
      Getter for expectedRows (a known row count, e.g., from count_records)

    • withExpectedRows

      public LaunchRequest withExpectedRows(Long expectedRows)
      Fluent setter for expectedRows

    • getRowSetSource

      public Map<String,Object> getRowSetSource()
      Getter for rowSetSource: for "retry failed rows", the parent job and the rows (row numbers or record keys) to run again.

    • withRowSetSource

      public LaunchRequest withRowSetSource(Map<String,Object> rowSetSource)
      Fluent setter for rowSetSource