Arvados-DCO-1.1-Signed-off-by: Radhika Chippada <radhika@curoverse.com>

[arvados.git] / doc / api / methods / job_tasks.html.textile.liquid

diff --git a/doc/api/methods/job_tasks.html.textile.liquid b/doc/api/methods/job_tasks.html.textile.liquid
index 2b2b111a2f36f8f6ebfe225bf21d1629059ae5aa..deee3a58069178c5cec23c3e7c9d188461140532 100644 (file)
--- a/doc/api/methods/job_tasks.html.textile.liquid
+++ b/doc/api/methods/job_tasks.html.textile.liquid
@@ -5,45 +5,63 @@ navmenu: API Methods
 title: "job_tasks"
 
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
 
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job_tasks@
 
-Required arguments are displayed in %{background:#ccffcc}green%.
+Object type: @ot0gb@
 
+Example UUID: @zzzzz-ot0gb-0123456789abcde@
 
-h2. create
+h2. Resource
 
-Create a new JobTask.
+Deprecated.
 
-Arguments:
+A job task is a individually scheduled unit of work executed as part of an overall job.
+
+Each JobTask has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|job_task|object||query||
+|_. Attribute|_. Type|_. Description|_. Example|
+|sequence|integer|Execution sequence.
+A step cannot be run until all steps with lower sequence numbers have completed.
+Job steps with the same sequence number can be run in any order.||
+|parameters|hash|||
+|output|text|||
+|progress|float|||
+|success|boolean|Is null if the task has neither completed successfully nor failed permanently.||
 
-h2. delete
+The following attributes should not be updated by anyone other than the job manager:
 
-Delete an existing JobTask.
+table(table table-bordered table-condensed).
+|_. Attribute|_. Type|_. Description|_. Notes|
+|qsequence|integer|Order of arrival|0-based|
+|job_uuid|string|||
+|created_by_job_task_uuid|string|||
 
-Arguments:
+h2. Methods
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
+See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
+
+Required arguments are displayed in %{background:#ccffcc}green%.
 
-h2. destroy
+h3. create
 
-destroy job_tasks
+Create a new JobTask.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+|job_task|object||query||
 
-h2. get
+h3. delete
 
-Gets a JobTask's metadata by UUID.
+Delete an existing JobTask.
 
 Arguments:
 
@@ -51,29 +69,23 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
 
-h2. list
+h3. get
 
-List job_tasks.
+Gets a JobTask's metadata by UUID.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-|limit|integer (default 100)|Maximum number of job_tasks to return.|query||
-|order|string|Order in which to return matching job_tasks.|query||
-|filters|array|Conditions for filtering job_tasks.|query||
-
-h2. show
+{background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
 
-show job_tasks
+h3. list
 
-Arguments:
+List job_tasks.
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 
-h2. update
+h3. update
 
 Update attributes of an existing JobTask.