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