JobRequest: JobRequest Class

Description Usage Format Fields

Description

A request to run a registered app.

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.

inputs

The application specific input files needed for this job. These vary from application to application and should be entered as multiple individual parameters in the form. Inputs may be given as relative paths in the user's default storage system or as URI. If a URI is given, the data will be staged in by the IO service and made avaialble to the application at run time.

memoryPerNode

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

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.

parameters

The application specific parameters needed for this job. These vary from application to application and should be entered as multiple individual parameters in the form. The actual dataType will be determined by the application description.

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.


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