doc/api/methods/job_tasks.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "job_tasks"
   6
   7 ...
   8
   9 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job_tasks@
  10
  11 Object type: @ot0gb@
  12
  13 Example UUID: @zzzzz-ot0gb-0123456789abcde@
  14
  15 h2. Resource
  16
  17 Deprecated.
  18
  19 A job task is a individually scheduled unit of work executed as part of an overall job.
  20
  21 Each JobTask has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Example|
  25 |sequence|integer|Execution sequence.
  26 A step cannot be run until all steps with lower sequence numbers have completed.
  27 Job steps with the same sequence number can be run in any order.||
  28 |parameters|hash|||
  29 |output|text|||
  30 |progress|float|||
  31 |success|boolean|Is null if the task has neither completed successfully nor failed permanently.||
  32
  33 The following attributes should not be updated by anyone other than the job manager:
  34
  35 table(table table-bordered table-condensed).
  36 |_. Attribute|_. Type|_. Description|_. Notes|
  37 |qsequence|integer|Order of arrival|0-based|
  38 |job_uuid|string|||
  39 |created_by_job_task_uuid|string|||
  40
  41 h2. Methods
  42
  43 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  44
  45 Required arguments are displayed in %{background:#ccffcc}green%.
  46
  47 h3. create
  48
  49 Create a new JobTask.
  50
  51 Arguments:
  52
  53 table(table table-bordered table-condensed).
  54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  55 |job_task|object||query||
  56
  57 h3. delete
  58
  59 Delete an existing JobTask.
  60
  61 Arguments:
  62
  63 table(table table-bordered table-condensed).
  64 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  65 {background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
  66
  67 h3. get
  68
  69 Gets a JobTask's metadata by UUID.
  70
  71 Arguments:
  72
  73 table(table table-bordered table-condensed).
  74 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  75 {background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
  76
  77 h3. list
  78
  79 List job_tasks.
  80
  81 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  82
  83 h3. update
  84
  85 Update attributes of an existing JobTask.
  86
  87 Arguments:
  88
  89 table(table table-bordered table-condensed).
  90 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  91 {background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
  92 |job_task|object||query||