1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/jobs.R
\name{jobSetState}
\alias{jobSetState}
\title{Set Background Job State}
\usage{
jobSetState(
job,
state = c("idle", "running", "succeeded", "cancelled", "failed")
)
}
\arguments{
\item{job}{The ID of the job on which to change state.}
\item{state}{The new job state.}
}
\description{
Changes the state of a background job.
}
\section{States}{
The following states are supported: \describe{ \item{idle}{The job is
waiting to run.} \item{running}{The job is actively running.}
\item{succeeded}{The job has finished successfully.} \item{cancelled}{The
job was cancelled.} \item{failed}{The job finished but did not succeed.} }
}
\seealso{
Other jobs:
\code{\link{jobAdd}()},
\code{\link{jobAddOutput}()},
\code{\link{jobAddProgress}()},
\code{\link{jobGetState}()},
\code{\link{jobList}()},
\code{\link{jobRemove}()},
\code{\link{jobRunScript}()},
\code{\link{jobSetProgress}()},
\code{\link{jobSetStatus}()}
}
\concept{jobs}
|
