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).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
+|*Attribute*|*Type*|*Description*|*Example*|
|api_token|string|||
|api_client_id|integer|||
|user_id|integer|||
|last_used_by_ip_address|string|||
|last_used_at|datetime|||
|expires_at|datetime|||
-|created_at|datetime|||
|updated_at|datetime|||
|default_owner_uuid|string|||
|scopes|Array|||
Each ApiClient has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
+|*Attribute*|*Type*|*Description*|*Example*|
|name|string|||
|url_prefix|string|||
|is_trusted|boolean|||
Each AuthorizedKey has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|name|string|||
|key_type|string|||
|authorized_user_uuid|string|||
|public_key|text|||
|expires_at|datetime|||
-|created_at|datetime|||
|updated_at|datetime|||
Each collection has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*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":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
+|*Attribute*|*Type*|*Description*|*Example*|
|repository_name|string|||
|sha1|string|||
|message|string|||
-|created_at|datetime|||
|updated_at|datetime|||
Each CommitAncestor has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
+|*Attribute*|*Type*|*Description*|*Example*|
|repository_name|string|||
|descendant|string|||
|ancestor|string|||
|is|boolean|||
-|created_at|datetime|||
|updated_at|datetime|||
Each Group has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|name|string|||
|description|text|||
|updated_at|datetime|||
Each Human has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|properties|Hash|||
-|created_at|datetime|||
|updated_at|datetime|||
+++ /dev/null
----
-layout: default
-navsection: api
-title: "Resource: Job"
-navorder: 101
----
-
-h1. Job
-
-A **Job** represents...
-
-h2. Methods
-
-See "REST methods for working with Arvados resources":methods.html
-
-API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job@
-
-h2. Creation
-
-h3. Prerequisites
-
-Prerequisites for creating a Job.
-
-h3. Side effects
-
-Side effects of creating a Job.
-
-h2. Resources
-
-Each Job has, in addition to the usual "attributes of Arvados resources":resources.html:
-
-table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
-|submit_id|string|||
-|script|string|||
-|script_version|string|||
-|script_parameters|Hash|||
-|cancelled_by_client_uuid|string|||
-|cancelled_by_user_uuid|string|||
-|cancelled_at|datetime|||
-|started_at|datetime|||
-|finished_at|datetime|||
-|running|boolean|||
-|success|boolean|||
-|output|string|||
-|created_at|datetime|||
-|updated_at|datetime|||
-|priority|string|||
-|is_locked_by_uuid|string|||
-|log|string|||
-|tasks_summary|Hash|||
-|runtime_constraints|Hash|||
+++ /dev/null
----
-layout: default
-navsection: api
-title: "Resource: JobTask"
-navorder: 101
----
-
-h1. JobTask
-
-A **JobTask** represents...
-
-h2. Methods
-
-See "REST methods for working with Arvados resources":methods.html
-
-API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job_task@
-
-h2. Creation
-
-h3. Prerequisites
-
-Prerequisites for creating a JobTask.
-
-h3. Side effects
-
-Side effects of creating a JobTask.
-
-h2. Resources
-
-Each JobTask has, in addition to the usual "attributes of Arvados resources":resources.html:
-
-table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
-|job_uuid|string|||
-|sequence|integer|||
-|parameters|Hash|||
-|output|text|||
-|progress|float|||
-|success|boolean|||
-|created_at|datetime|||
-|updated_at|datetime|||
-|created_by_job_task_uuid|string|||
-|qsequence|integer|||
API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job_tasks@
-h2. Resource
+h2. Resources
-Each job has, in addition to the usual "attributes of Arvados resources":resources.html:
+Each JobTask has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|
+|*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{}|list||
-|runtime_constraints{}|list|Constraints that must be satisfied by the job/task scheduler in order to run the task (see "Jobs":Jobs.html).|
-|output|string||
-|progress|float||
-|success|boolean|Is null if the task has neither completed successfully nor failed permanently.|
+Job steps with the same sequence number can be run in any order.||
+|parameters{}|list|||
+|output|text|||
+|progress|float|||
+|success|boolean|Is null if the task has neither completed successfully nor failed permanently.||
The following attributes should not be updated by anyone other than the job manager:
table(table table-bordered table-condensed).
|*Attribute*|*Type*|*Description*|*Notes*|
|qsequence|integer|Order of arrival|0-based|
-|failed_count|number|Times this step has failed||
-|failed_at|number|Time of last failure|Is null if failed_count=0|
-|failed_log|string|stderr from last failure|Is null if failed_count=0|
-|log|string|stderr||
+|job_uuid|string|||
+|created_by_job_task_uuid|string|||
-h3. Resource limits
-
-table(table table-bordered table-condensed).
-|*Key*|*Type*|*Description*|*Implemented*|
-|min_nodes|integer|||
-|max_nodes|integer|||
-|max_tasks_per_node|integer|Maximum simultaneous tasks on a single node|✓|
-|min_ram_per_task|integer|Minimum real memory (KiB) per task||
-|min_ram_per_node|integer|Minimum real memory (KiB) per node||
Each job has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*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.|
|script_version|string|git commit/tree used when running the job|This can be submitted as an unambiguous prefix of a commit sha1, "repository:tag", or "repository:branch". Before the job starts, Arvados will resolve it to a full 40-character git commit sha1.|
|cancelled_by_client_uuid|string|API client ID|Is null if job has not been cancelled|
|cancelled_by_user_uuid|string|Authenticated user ID|Is null if job has not been cancelled|
-|cancelled_at|string|When job was cancelled|Is null if job has not been cancelled|
+|cancelled_at|datetime|When job was cancelled|Is null if job has not been cancelled|
|started_at|datetime|When job started running|Is null if job has not [yet] started|
|finished_at|datetime|When job finished running|Is null if job has not [yet] finished|
|running|boolean|Whether the job is running||
|success|boolean|Whether the job indicated successful completion|Is null if job has not finished|
|is_locked_by_uuid|string|UUID of the user who has locked this job|Is null if job is not locked. The system user locks the job when starting the job, in order to prevent job attributes from being altered.|
+|log|string|||
+|tasks_summary|Hash|||
+|output|string|||
h3. Runtime constraints
|max_nodes|integer|||
|max_tasks_per_node|integer|Maximum simultaneous tasks on a single node|✓|
|min_ram_per_task|integer|Minimum real memory (KiB) per task||
-|min_ram_per_node|integer|Minimum real memory (KiB) per node||
\ No newline at end of file
+|min_ram_per_node|integer|Minimum real memory (KiB) per node||
Each KeepDisk has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|ping_secret|string|||
|node_uuid|string|||
|filesystem_uuid|string|||
|last_read_at|datetime|||
|last_write_at|datetime|||
|last_ping_at|datetime|||
-|created_at|datetime|||
|updated_at|datetime|||
|service_host|string|||
|service_port|integer|||
Each Link has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|tail_uuid|string|||
|tail_kind|string|||
|link_class|string|||
Each Log has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
+|*Attribute*|*Type*|*Description*|*Example*|
|object_kind|string|||
|object_uuid|string|||
|event_at|datetime|||
|event_type|string|||
|summary|text|||
|info|Hash|||
-|created_at|datetime|||
|updated_at|datetime|||
-|modified_at|datetime|||
Each Node has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|slot_number|integer|||
|hostname|string|||
|domain|string|||
Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|pipeline_template_uuid|string|||
|name|string|||
|components|Hash|||
Each PipelineTemplate has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|name|string|||
|components|Hash|||
|updated_at|datetime|||
Each Repository has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|name|string|||
|fetch_url|string|||
|push_url|string|||
-|created_at|datetime|||
|updated_at|datetime|||
Each Specimen has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|material|string|||
|updated_at|datetime|||
|properties|Hash|||
Each Trait has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|name|string|||
|properties|Hash|||
-|created_at|datetime|||
|updated_at|datetime|||
Each User has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|email|string|||
|first_name|string|||
|last_name|string|||
Each VirtualMachine has, in addition to the usual "attributes of Arvados resources":resources.html:
table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
|hostname|string|||
-|created_at|datetime|||
|updated_at|datetime|||
h2. Attributes of resources
table(table table-bordered table-condensed).
-|*Attribute name*|*Value*|*Description*|*Example*|
+|*Attribute*|*Type*|*Description*|*Example*|
|uuid|string|universally unique object identifier|@mk2qn-4zz18-w3anr2hk2wgfpuo@|
|href|string|a URL that can be used to address this resource||
|kind|string|@arvados#{resource_type}@|@arvados#collection@|
h2. Attributes of resource lists
table(table table-bordered table-condensed).
-|*Attribute name*|*Value*|*Description*|*Example*|
+|*Attribute*|*Type*|*Description*|*Example*|
|kind|string|@arvados#{resource_type}_list@|@arvados#project_list@|
|etag|string|The ETag[1] of the resource list|@cd3o1wi9sf934saajykawrz2e@|
|self_link|string|||