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