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 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15 h2. Resource
  16
  17 Each JobTask has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  18
  19 table(table table-bordered table-condensed).
  20 |_. Attribute|_. Type|_. Description|_. Example|
  21 |sequence|integer|Execution sequence.
  22 A step cannot be run until all steps with lower sequence numbers have completed.
  23 Job steps with the same sequence number can be run in any order.||
  24 |parameters|hash|||
  25 |output|text|||
  26 |progress|float|||
  27 |success|boolean|Is null if the task has neither completed successfully nor failed permanently.||
  28
  29 The following attributes should not be updated by anyone other than the job manager:
  30
  31 table(table table-bordered table-condensed).
  32 |_. Attribute|_. Type|_. Description|_. Notes|
  33 |qsequence|integer|Order of arrival|0-based|
  34 |job_uuid|string|||
  35 |created_by_job_task_uuid|string|||
  36
  37
  38
  39 h2. Methods
  40
  41 h3. create
  42
  43 Create a new JobTask.
  44
  45 Arguments:
  46
  47 table(table table-bordered table-condensed).
  48 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  49 |job_task|object||query||
  50
  51 h3. delete
  52
  53 Delete an existing JobTask.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  59 {background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
  60
  61 h3. get
  62
  63 Gets a JobTask's metadata by UUID.
  64
  65 Arguments:
  66
  67 table(table table-bordered table-condensed).
  68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  69 {background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
  70
  71 h3. list
  72
  73 List job_tasks.
  74
  75 Arguments:
  76
  77 table(table table-bordered table-condensed).
  78 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  79 |limit|integer (default 100)|Maximum number of job_tasks to return.|query||
  80 |order|string|Order in which to return matching job_tasks.|query||
  81 |filters|array|Conditions for filtering job_tasks.|query||
  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||