Job: Job Class

Description Usage Format Fields

Description

Job Class

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Fields

appId

The unique name of the application being run by this job. This must be a valid application that the calling user has permission to run.

archive

Whether the output from this job should be archived. If true, all new files created by this application's execution will be archived to the archivePath in the user's default storage system.

archivePath

The path of the archive folder for this job on default storage sytem of the user

archiveSystem

The unique id of the storage system on which this job output will be staged.

batchQueue

The queue to which this job should be submitted. This is optional and only applies when the execution system has a batch scheduler.

endTime

The date the job stopped running due to termination, completion, or error in ISO 8601 format.

executionSystem

The system id of the execution system.

id

The unique id of the job.

inputs
localId

The process or local job id of the job on the remote execution system.

memoryPerNode

The requested memory for this application to run given in GB.

message

The error message incurred when the job failed.

name

The name of the job.

nodeCount

The number of processors this application should utilize while running. If the application is not of executionType PARALLEL, this should be 1.

notifications

An array of notifications you wish to receive.

outputPath

Relative path of the job output data.

owner

The job owner.

parameters
processorsPerNode

The number of processors this application should utilize while running. If the application is not of executionType PARALLEL, this should be 1.

maxRunTime

The requested compute time needed for this application to complete given in HH:mm:ss format.

retries

The number of retires it took to submit this job.

startTime

The date the job started in ISO 8601 format.

status

The status of the job. Possible values are: PENDING, STAGING_INPUTS, CLEANING_UP, ARCHIVING, STAGING_JOB, FINISHED, KILLED, FAILED, STOPPED, RUNNING, PAUSED, QUEUED, SUBMITTING, STAGED, PROCESSING_INPUTS, ARCHIVING_FINISHED, ARCHIVING_FAILED

submitTime

The date the job was submitted in ISO 8601 format.

workPath

The directory on the remote execution system from which the job is running.


agaveplatform/r-sdk documentation built on Sept. 22, 2018, 2:14 p.m.