table(table table-bordered table-condensed).
|Environment variable|Description|
-|@JOB_UUID@|UUID of the current "Job":schema/Jobs.html|
-|@TASK_UUID@|UUID of the current "JobTask":schema/JobTasks.html|
+|@JOB_UUID@|UUID of the current "Job":schema/Job.html|
+|@TASK_UUID@|UUID of the current "JobTask":schema/JobTask.html|
|@ARVADOS_API_HOST@|Hostname and port number of API server|
|@ARVADOS_API_TOKEN@|Authentication token to use with API calls made by the current task|
* Resources in requests and responses adhere to a "common structure":resources.html.
* API transactions use common "REST methods":methods.html.
* API transactions are subject to a "permission model":permission-model.html.
-* "Job tasks":schema/JobTasks.html use some special API features.
+* "Job tasks":schema/JobTask.html use some special API features.
h2. Resources
h3. Generic Resources
-* "Collections":schema/Collections.html
-* "Jobs":schema/Jobs.html
-* "JobTasks":schema/JobTasks.html
-* "Links":schema/Links.html
+* "Collection":schema/Collection.html
+* "Job":schema/Job.html
+* "JobTask":schema/JobTask.html
+* "Link":schema/Link.html
* "Log":schema/Log.html
* "PipelineTemplate":schema/PipelineTemplate.html
* "PipelineInstance":schema/PipelineInstance.html
These Arvados resources govern authorization and "authentication":authentication.html:
-* "ApiClients":schema/ApiClients.html
+* "ApiClient":schema/ApiClient.html
* "ApiClientAuthorization":schema/ApiClientAuthorization.html
* "AuthorizedKey":schema/AuthorizedKey.html
Each ApiClient has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|url_prefix|string|||
|is_trusted|boolean|||
An ApiClientAuthorization is not a generic Arvados resource. The full list of properties that belong to an ApiClientAuthorization is:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|api_token|string|||
|api_client_id|integer|||
|user_id|integer|||
Each AuthorizedKey has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|key_type|string|||
|authorized_user_uuid|string|||
h1. Collection
-This resource concerns metadata, usage accounting, and integrity checks for data stored on the cloud. Reading and writing the data _per se_ is achieved by the "Keep":{{ baseurl }}/user/intro-keep.html storage system.
+This resource concerns metadata, usage accounting, and integrity checks for data stored on the cloud. Reading and writing the data _per se_ is achieved by the "Keep":/user/tutorials/tutorial-keep.html storage system.
h2. Methods
Each collection has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|locator|string|||
|portable_data_hash|string|||
|name|string|||
Each Commit has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|repository_name|string|||
|sha1|string|||
|message|string|||
Each CommitAncestor has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|repository_name|string|||
|descendant|string|||
|ancestor|string|||
Each Group has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|description|text|||
|updated_at|datetime|||
Each Human has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|properties|Hash|||
|updated_at|datetime|||
h3. Additional parameters for "Create" method
table(table table-bordered table-condensed).
-|*Parameter name*|*Type*|*Description*|
+|_. Parameter name|_. Type|_. Description|
|allow_duplicate|boolean|If true, a new job is submitted even if an identical job has already been submitted (and has not failed). If false or not supplied, a new job will _not_ be submitted and the existing job will be returned in the API response.|
h3. Queue
Each job has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Notes*|
+|_. Attribute|_. Type|_. Description|_. Notes|
|submit_id|string|Unique ID provided by client when job was submitted|Optional. Can be used by client to ensure idempotence|
|priority|string|||
|runtime_constraints{}|list|Constraints that must be satisfied by the job/task scheduler in order to run the job.|See below.|
h3. Runtime constraints
table(table table-bordered table-condensed).
-|*Key*|*Type*|*Description*|*Implemented*|
+|_. Key|_. Type|_. Description|_. Implemented|
|dependencies{}|list|[
{
"name": "freebayes",
h1. JobTask
-A Job Task is a well defined independently-computable portion of a "Job":Jobs.html.
+A Job Task is a well defined independently-computable portion of a "Job":Job.html.
Job tasks are created two ways:
* When a job starts, it is seeded with a job task with @sequence=0@ and an empty @parameters{}@ list.
Each JobTask has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. 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.||
The following attributes should not be updated by anyone other than the job manager:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Notes*|
+|_. Attribute|_. Type|_. Description|_. Notes|
|qsequence|integer|Order of arrival|0-based|
|job_uuid|string|||
|created_by_job_task_uuid|string|||
Each KeepDisk has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|ping_secret|string|||
|node_uuid|string|||
|filesystem_uuid|string|||
Each link has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|
+|_. Attribute|_. Type|_. Description|
|tail_uuid|string|Object UUID at the tail (start, source, origin) of this link|
|tail_kind|string|Object kind at the tail (start, source, origin) of this link|
|link_class|string|Class (see below)|
Some classes are pre-defined by convention and have standard meanings attached to names.
table(table table-bordered table-condensed).
-|*link_class*|*tail_type→head_type*|*name→head_uuid {properties}*|*Notes*|
+|_. link_class|_. tail_type→head_type|_. name→head_uuid {properties}|_. Notes|
|provenance|→Collection |provided → _collection uuid_
{url→http://example.com/foo.tgz, retrieved_at→1352616640.000}||
|provenance|Job→Collection |provided → _collection uuid_||
Each Log has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|object_kind|string|||
|object_uuid|string|||
|event_at|datetime|||
Each Node has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|slot_number|integer|||
|hostname|string|||
|domain|string|||
Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|pipeline_template_uuid|string|||
|name|string|||
|components|Hash|||
Each PipelineTemplate has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|components|Hash|||
|updated_at|datetime|||
Each Repository has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|fetch_url|string|||
|push_url|string|||
Each Specimen has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|material|string|||
|updated_at|datetime|||
|properties|Hash|||
Each Trait has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|properties|Hash|||
|updated_at|datetime|||
Each User has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|email|string|||
|first_name|string|||
|last_name|string|||
Each VirtualMachine has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|hostname|string|||
|updated_at|datetime|||
projects / arvados.git / commitdiff