parallel.Task - Access task properties and behaviors - MATLAB (original) (raw)
Main Content
Access task properties and behaviors
Container Hierarchy
| Parent | parallel.Job |
|---|---|
| Children | none |
Description
A parallel.Task object provides access to a task, which executes on a worker as part of a job.
Types
The following table describes the available types of task objects, determined by the type of cluster.
| Task Type | Description |
|---|---|
| parallel.task.MJSTask | Task on MATLAB® Job Scheduler cluster |
| parallel.task.CJSTask | Task on CJS cluster |
Methods
All task type objects have the same methods, described in the following table.
| cancel | Cancel job or task |
|---|---|
| delete | Remove job or task object from cluster and memory |
Properties
Common to All Task Types
The following properties are common to all task object types.
| Property | Description |
|---|---|
| CaptureDiary | Specify whether to return diary output |
| CreateDateTime | Date and time when the task is created |
| Diary | Text produced by execution of task object's function |
| Error | Task error information |
| ErrorIdentifier | Task error identifier |
| ErrorMessage | Message from task error |
| FinishDateTime | Date and time when the task is finished |
| Function | Function called when evaluating task |
| ID | Task's numeric identifier |
| InputArguments | Input arguments to task function |
| Name | Name of this task |
| NumOutputArguments | Number of arguments returned by task function |
| OutputArguments | Output arguments from running task function on worker |
| Parent | Job object containing this task |
| RunningDuration | Current duration of the task, specified as a duration object. |
| StartDateTime | Date and time when the task is started |
| State | Current state of task |
| UserData | Information associated with this task object |
| Warnings | Warning information issued during execution of the task, captured in a struct array with the fields message, identifier, and stack |
| Worker | Object representing worker that ran this task |
MATLAB Job Scheduler Tasks
MATLAB Job Scheduler task objects have the following properties in addition to the common properties:
| Property | Description |
|---|---|
| FailureInfo | Information returned from failed task |
| FinishedFcn | Callback executed in client when task finishes |
| MaximumRetries | Maximum number of times to rerun failed task |
| NumFailures | Number of times tasked failed |
| RunningFcn | Callback executed in client when task starts running |
| Timeout | Time limit, in seconds, to complete task |
CJS Tasks
CJS task objects have the following properties in addition to the common properties:
| Property | Description |
|---|---|
| SchedulerID | If you have submitted the task to a third-party scheduler, this is the ID that the scheduler gives to the task on submission. For example, this corresponds to the JOBID on a SLURM scheduler. |
Help
To get further help on either type of parallel.Task object, including a list of links to help for its properties, type:
help parallel.task.MJSTask help parallel.task.CJSTask
Version History
Introduced in R2012a