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 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job_tasks@
  12
  13 UUID type: @ot0gb@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 Deprecated.
  20
  21 A job task is a individually scheduled and task executed as part of an overall job.
  22
  23 Each JobTask has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  24
  25 table(table table-bordered table-condensed).
  26 |_. Attribute|_. Type|_. Description|_. Example|
  27 |sequence|integer|Execution sequence.
  28 A step cannot be run until all steps with lower sequence numbers have completed.
  29 Job steps with the same sequence number can be run in any order.||
  30 |parameters|hash|||
  31 |output|text|||
  32 |progress|float|||
  33 |success|boolean|Is null if the task has neither completed successfully nor failed permanently.||
  34
  35 The following attributes should not be updated by anyone other than the job manager:
  36
  37 table(table table-bordered table-condensed).
  38 |_. Attribute|_. Type|_. Description|_. Notes|
  39 |qsequence|integer|Order of arrival|0-based|
  40 |job_uuid|string|||
  41 |created_by_job_task_uuid|string|||
  42
  43
  44
  45 h2. Methods
  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 Arguments:
  82
  83 table(table table-bordered table-condensed).
  84 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  85 |limit|integer (default 100)|Maximum number of job_tasks to return.|query||
  86 |order|string|Order in which to return matching job_tasks.|query||
  87 |filters|array|Conditions for filtering job_tasks.|query||
  88
  89 h3. update
  90
  91 Update attributes of an existing JobTask.
  92
  93 Arguments:
  94
  95 table(table table-bordered table-condensed).
  96 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  97 {background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
  98 |job_task|object||query||