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