node-deadline
Version:
Module to interface with Deadline Compute Management System by Thinkbox Software
35 lines (28 loc) • 1.77 kB
Markdown
#Deadline.tasks.Task
Represents a singular task from the Deadline database. Also available as `Deadline.Task`.
###Properties
| Property | type | Maps to | Description
|---------------|--------|---------------|-------------
| id | String | _id | The unique id of the task
| jobID | String | JobID | The id of the job this task belongs to
| taskID | Number | TaskID | the id of this task relative to the job
| frames | FrameRange|Frames | the frames that are being rendered by this task
| slave | ??? | Slave | the slave this job belongs to (at time of access)
| state | Number | Stat | the sate of the task (at time of access)
| renderStatus | String | RndStat | the current status of the renderer
| errors | Number | Errs | the number of errors this task has hit
| startTime | Date | Start | time this task was picked up by a slave for rendering
| renderStart | Date | StartRen | time this task started rendering
| completeTime | Date | Comp | time this task completed
| | Bool | WtgStrt | ???
**NOTE:** properties with no name have yet to be assigned, but are available in the *task._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 *task._updated*
array in order to have the information change when the task is saved.
###Deadline.slaves.Slave.set( properties )
Sets the given properties on this task. The **properties** object is a set of key-value pairs to update with.
```javasccript
task.set( {
frames: "My new frame range"
} );
```