Public API
SimpleWorkflows.Workflow
— TypeWorkflow(jobs::AbstractJob...)
Create a Workflow
from a given series of AbstractJob
s.
The list of AbstractJob
s does not have to be complete, our algorithm will find all connected AbstractJob
s automatically.
EasyJobsBase.run!
— Functionrun!(wf::Workflow; maxattempts=5, interval=1, delay=0)
Run a Workflow
with maximum number of attempts, with each attempt separated by a few seconds.
EasyJobsBase.execute!
— Functionexecute!(workflow::AbstractWorkflow, exec::Executor)
Executes the jobs from the workflow of the provided Executor instance.
The function will attempt to execute all the jobs up to exec.maxattempts
times. If all jobs have succeeded, the function will stop immediately. Otherwise, it will wait for a duration equal to exec.interval
before the next attempt.
EasyJobsBase.getstatus
— Functiongetstatus(wf::AbstractWorkflow)
Get the current status of jobs in a AbstractWorkflow
as a graph.
SimpleWorkflows.liststatus
— Functionliststatus(wf::AbstractWorkflow)
List the current status of jobs in a AbstractWorkflow
as a vector.
See also getstatus
.
EasyJobsBase.ispending
— Functionispending(wf::AbstractWorkflow)
Check if all jobs in the AbstractWorkflow
are in a pending state.
Return true
if all jobs are pending, otherwise, return false
.
EasyJobsBase.isrunning
— Functionisrunning(wf::AbstractWorkflow)
Check if any job in the AbstractWorkflow
is currently running.
Return true
if at least one job is running, otherwise, return false
.
EasyJobsBase.isexited
— Functionisexited(wf::AbstractWorkflow)
Check if all jobs in the AbstractWorkflow
have exited.
Return true
if all jobs have exited, otherwise, return false
.
EasyJobsBase.issucceeded
— Functionissucceeded(wf::AbstractWorkflow)
Check if all jobs in the AbstractWorkflow
have successfully completed.
Return true
if all jobs have succeeded, otherwise, return false
.
EasyJobsBase.isfailed
— Functionisfailed(wf::AbstractWorkflow)
Check if any job in the AbstractWorkflow
has failed, given that all jobs have exited.
Return true
if any job has failed after all jobs have exited, otherwise, return false
.
EasyJobsBase.listpending
— Functionlistpending(wf::AbstractWorkflow)
Filter only the pending jobs in a Workflow
.
EasyJobsBase.listrunning
— Functionlistrunning(wf::AbstractWorkflow)
Filter only the running jobs in a Workflow
.
EasyJobsBase.listexited
— Functionlistexited(wf::AbstractWorkflow)
Filter only the exited jobs in a Workflow
.
EasyJobsBase.listsucceeded
— Functionlistsucceeded(wf::AbstractWorkflow)
Filter only the succeeded jobs in a Workflow
.
EasyJobsBase.listfailed
— Functionlistfailed(wf::AbstractWorkflow)
Filter only the failed jobs in a Workflow
.