X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b54d7820e899733ce10b8960b1f04d0481f2e11f..b6e28fbe905737bd0ea5bda5f4fd74fd259c58b1:/doc/api/schema/PipelineInstance.html.textile.liquid diff --git a/doc/api/schema/PipelineInstance.html.textile.liquid b/doc/api/schema/PipelineInstance.html.textile.liquid index 7fd62f06e0..75c788533b 100644 --- a/doc/api/schema/PipelineInstance.html.textile.liquid +++ b/doc/api/schema/PipelineInstance.html.textile.liquid @@ -6,36 +6,21 @@ title: PipelineInstance ... -h1. PipelineInstance - -A **PipelineInstance** represents... +A **PipelineInstance** is the act or record of applying a pipeline template to a specific set of inputs; generally, a pipeline instance refers to a set of jobs that have been run to satisfy the pipeline components. h2. Methods -See "REST methods for working with Arvados resources":/api/methods.html - -API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instance@ - -h2. Creation - -h3. Prerequisites - -Prerequisites for creating a PipelineInstance. - -h3. Side effects - -Side effects of creating a PipelineInstance. +See "pipeline_instances":{{site.baseurl}}/api/methods/pipeline_instances.html -h2. Resources +h2. Resource -Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":/api/resources.html: +Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| |pipeline_template_uuid|string||| |name|string||| -|components|Hash||| +|components|hash||| |success|boolean||| |active|boolean||| -|updated_at|datetime||| |properties|Hash|||