jobSetState {rstudioapi}

Set Background Job State

Description

Changes the state of a background job.

Usage

jobSetState(
  job,
  state = c("idle", "running", "succeeded", "cancelled", "failed")
)

Arguments

job

The ID of the job on which to change state.

state

The new job state.

States

The following states are supported:

idle

The job is waiting to run.

running

The job is actively running.

succeeded

The job has finished successfully.

cancelled

The job was cancelled.

failed

The job finished but did not succeed.

See Also

Other jobs: jobAdd(), jobAddOutput(), jobAddProgress(), jobGetState(), jobList(), jobRemove(), jobRunScript(), jobSetProgress(), jobSetStatus()