node-deadline
Version:
Module to interface with Deadline Compute Management System by Thinkbox Software
73 lines (63 loc) • 4.32 kB
Markdown
Represents a singular Job from the Deadline database. Also available as `Deadline.Job`.
| Property | type | Maps to | Description
|---------------|--------|---------------|------------
| id | String | _id | The unique id of the job
| status | Enum | Stat | The status of this job
| updated | Date | LastWriteTime | The last time the job was updated (when acessed)
| name | String | Props.Name | The name of the job
| user | String | Props.User | The user who submitted the job
| batch | String | Props.Batch | The jobs batch
| comment | String | Props.Cmmt | The comment on the job
| commentTag | String | Props.CmmtTag | The tag(s) on the comment
| department | String | Props.Dept | The department of the job
| frames | FrameRange|Props.Frames| A Deadline.jobs.FrameRange object denoting the frames of the job
| | Number | Props.Chunk | ???
| tasks | Number | Props.Tasks | The number of tasks for this job
| group | String | Props.Grp | The job's group
| pool | String | Props.Pool | The job's primary pool
| secondaryPool | String | Props.SecPool | The job's seconday pool
| priority | Number | Props.Pri | The job's priority
| requiredAssets| Array | Props.ReqAss | The assets required for this job
| scriptDependancies|Array|Props.ScrDept | The scripts on which this job depends
| concurrentTasks|Number | Props.Conc | Max number of concurrent tasks
| limitConcurrent|Bool | Props.ConcLimt| Weather to limit tasks to slave's task limit
| auxSync | Bool | Props.AuxSync | Weather to sync auxilliary files between tasks
| interruptable | Bool | Props.Int | Weather the job is interruptable
| interruptLimit| Number | Props.IntPer | The percentage (0-100) when interrupt is no longer allowed
| sequential | Bool | Props.Seq | Weather to enforce sequential rendering
| reload | Bool | Props.Reload | Weather to reload plugins between tasks
| suppressEvents| Bool | Props.NoEvt | Weather to suppress event plugins on this job
| | Number | Props.OnComp | ???
| protected | Bool | Props.Protect | Weather the job is protected
| timeout | Number | Props.Timeout | ???
| frameTimeout | Bool | Props.FrameTimout|Weather the timout is for frames instead of tasks
| limits | Array | Props.Limits | Limits for this job
| listedSlaves | Array | Props.ListedSlaves|Slaves listed for this job (either black or white)
| listedWhite | Bool | Props.White | If true, the listed slaves are whitelisted, otherwise blacklisted
| extraInfo | Object | Props.Ex* | A collection of all extra info on the job, including key-value pairs
| machine | String | Mach | The machine used for submission
| date | Date | Date | The submission date/time
| dateStarted | Date | DateStart | The date the job was started
| dateCompleted | Date | DateComp | The date the job was completed
| plugin | String | Plug | The plugin for this job (if any)
| outputDirectories|Array | OutDir | The output directory(s) for this job
| outputFiles | Array | OutFile | The output file(s) for this job
| badSlaves | Array | Bad | Names of any slaves marked as bad for this job
| chunks | Object | *Multiple* | Object of chunks/tasks for this job (ex chunks.completed = 5)
| errors | Number | Errs | Number of errors on this job
**NOTE:** properties with no name have yet to be assigned, but are available in the *job._data* object.
There are also other properties on that object which are not listed here.
Be aware that changing these options directly requires that you add the property name to the *job._updated*
array in order to have the information change when the job is saved.
###Deadline.jobs.Job.getTasks()
Returns the Deadline.tasks.Task objects belonging to this job (as an array).
###Deadline.jobs.Job.set( properties )
Sets the given properties on this job. The **properties** object is a set of key-value pairs to update with.
```javasccript
job.set( {
name: "My new job name",
user: "newJobUser"
} );
```