doc/api/JobTasks.textile

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Schema
   5 title: "Resource: JobTasks"
   6 navorder: 16
   7 ---
   8
   9 h1. JobTasks
  10
  11 A Job Task is a well defined independently-computable portion of a "Job":Jobs.html.
  12
  13 Job tasks are created two ways:
  14 * When a job starts, it is seeded with a job task with @sequence=0@ and an empty @parameters{}@ list.
  15 * Job task A can create additional job tasks B, C, D, which will belong to the same job. Tasks B, C, D will not be performed until job task A is complete. If job task A fails, tasks B, C, D will be deleted.
  16
  17 Job tasks have particular update semantics:
  18 * Progress reporting: A job task should only be <code>PATCH</code>ed by a worker process which has been dispatched to work on that task and is reporting progress or completion status &mdash; and by the job manager itself.
  19 * Completion: When a job task process terminates, the task is considered complete only if its most recent @PATCH@ transaction had @progress=1.0@ and @success=true@.
  20 * Temporary failure: If a job task process terminates without updating @success@ to @true@ or @false@, it is assumed that the task failed but is worth re-attempting (at a different time, on a different node, etc).
  21
  22
  23 h2. Methods
  24
  25 See "REST methods for working with Arvados resources":methods.html
  26
  27 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job_tasks@
  28
  29 h2. Resources
  30
  31 Each JobTask has, in addition to the usual "attributes of Arvados resources":resources.html:
  32
  33 table(table table-bordered table-condensed).
  34 |*Attribute*|*Type*|*Description*|*Example*|
  35 |sequence|integer|Execution sequence.
  36 A step cannot be run until all steps with lower sequence numbers have completed.
  37 Job steps with the same sequence number can be run in any order.||
  38 |parameters{}|list|||
  39 |output|text|||
  40 |progress|float|||
  41 |success|boolean|Is null if the task has neither completed successfully nor failed permanently.||
  42
  43 The following attributes should not be updated by anyone other than the job manager:
  44
  45 table(table table-bordered table-condensed).
  46 |*Attribute*|*Type*|*Description*|*Notes*|
  47 |qsequence|integer|Order of arrival|0-based|
  48 |job_uuid|string|||
  49 |created_by_job_task_uuid|string|||
  50
  51