mantaJob.done: Checks or polls status of a Manta job. Returns done or not as...

Description Usage Arguments Value See Also Examples

View source: R/mantaJob.done.R

Description

Checks or polls status of a Manta job. Returns done or not as logical.

Usage

1
2
mantaJob.done(jobid, poll = FALSE, sleep = 30, timeout = 600,
  silent = FALSE)

Arguments

jobid

character optional. Manta job identifier such as "70c30bab-873b-66da-ebc8-ced12bd35ac4". Default uses mantaJobs.tail to fetch the jobid of the last Manta Job run on the service

poll

logical. Set to TRUE to poll. Returns FALSE when poll timeout exceeded and job still running, TRUE when job finished.

sleep

integer. Sleep interval used when polling. Default is 30 seconds.

timeout

integer. Seconds after which function stops polling. Default is 600 seconds.

silent

logical required. Set to TRUE for non-interactive use of the function. N.B. Errors are logged to the bunyan buffer.

Value

TRUE when job is no longer running.
FALSE when job running.
NULL if job status not found.
N.B. TRUE return does not imply job success/failure/errors, only running/done state.

See Also

Other mantaJobs: mantaJob.cancel; mantaJob.errors.stderr; mantaJob.errors; mantaJob.failures; mantaJob.inputs; mantaJob.launch; mantaJob.outputs.cat; mantaJob.outputs; mantaJob.setup; mantaJob.status; mantaJobs.running; mantaJobs.tail; mantaJobs; mantaMap; mantaReduce

Examples

1
2
3
4
5
6
7
## Not run: 
## Test if last run job is done
mantaJob.done()
## Poll a running job till done or timed out.
mantaJob.done(poll = TRUE, sleep = 10, timeout = 60)

## End(Not run)

joyent/mantaRSDK documentation built on May 19, 2019, 10:43 p.m.