doc/api/methods/pipeline_templates.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "pipeline_templates"
   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/pipeline_templates@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15 h2. Resource
  16
  17 Each PipelineTemplate 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 |name|string|||
  22 |components|hash|||
  23
  24 The pipeline template consists of "name" and "components".
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute    |_. Type |_. Accepted values                           |_. Required|_. Description|
  28 |name            |string  |any                                          |yes        |The human-readable name of the pipeline template.|
  29 |components      |object  |JSON object containing job submission objects|yes        |The component jobs that make up the pipeline, with the component name as the key. |
  30
  31 h3. Components
  32
  33 The components field of the pipeline template is a JSON object which describes the individual steps that make up the pipeline.  Each component is an Arvados job submission.  "Parameters for job submissions are described on the job method page.":{{site.baseurl}}/api/methods/jobs.html#create  In addition, a component can have the following parameters:
  34
  35 table(table table-bordered table-condensed).
  36 |_. Attribute    |_. Type          |_. Accepted values |_. Required|_. Description|
  37 |output_name     |string or boolean|string or false    |no         |If a string is provided, use this name for the output collection of this component.  If the value is false, do not create a permanent output collection (an temporary intermediate collection will still be created).  If not provided, a default name will be assigned to the output.|
  38
  39 h3. Script parameters
  40
  41 When used in a pipeline, each parameter in the 'script_parameters' attribute of a component job can specify that the input parameter must be supplied by the user, or the input parameter should be linked to the output of another component.  To do this, the value of the parameter should be JSON object containing one of the following attributes:
  42
  43 table(table table-bordered table-condensed).
  44 |_. Attribute    |_. Type |_. Accepted values                               |_. Description|
  45 |default         |any     |any                                              |The default value for this parameter.|
  46 |required        |boolean |true or false                                    |Specifies whether the parameter is required to have a value or not.|
  47 |dataclass       |string  |One of 'Collection', 'File' [1], 'number', or 'text' |Data type of this parameter.|
  48 |search_for      |string  |any string                                       |Substring to use as a default search string when choosing inputs.|
  49 |output_of       |string  |the name of another component in the pipeline    |Specifies that the value of this parameter should be set to the 'output' attribute of the job that corresponds to the specified component.|
  50 |title           |string  |any string                                       |User friendly title to display when choosing parameter values|
  51 |description     |string  |any string                                       |Extended text description for describing expected/valid values for the script parameter|
  52 |link_name       |string  |any string                                       |User friendly name to display for the parameter value instead of the actual parameter value|
  53
  54 The 'output_of' parameter is especially important, as this is how components are actually linked together to form a pipeline.  Component jobs that depend on the output of other components do not run until the parent job completes and has produced output.  If the parent job fails, the entire pipeline fails.
  55
  56 fn1. The 'File' type refers to a specific file within a Keep collection in the form 'collection_hash/filename', for example '887cd41e9c613463eab2f0d885c6dd96+83/bob.txt'.
  57
  58 The 'search_for' parameter is meaningful only when input dataclass of type Collection or File is used. If a value is provided, this will be preloaded into the input data chooser dialog in Workbench. For example, if your input dataclass is a File and you are interested in a certain filename extention, you can preconfigure it in this attribute.
  59
  60 h3. Examples
  61
  62 This is a pipeline named "Filter MD5 hash values" with two components, "do_hash" and "filter".  The "input" script parameter of the "do_hash" component is required to be filled in by the user, and the expected data type is "Collection".  This also specifies that the "input" script parameter of the "filter" component is the output of "do_hash", so "filter" will not run until "do_hash" completes successfully.  When the pipeline runs, past jobs that meet the criteria described above may be substituted for either or both components to avoid redundant computation.
  63
  64 <notextile><pre>
  65 {
  66   "name": "Filter MD5 hash values",
  67   "components": {
  68     "do_hash": {
  69       "script": "hash.py",
  70       "repository": "<b>you</b>/<b>you</b>",
  71       "script_version": "master",
  72       "script_parameters": {
  73         "input": {
  74           "required": true,
  75           "dataclass": "Collection",
  76           "search_for": ".fastq.gz",
  77           "title":"Please select a fastq file"
  78         }
  79       },
  80     },
  81     "filter": {
  82       "script": "0-filter.py",
  83       "repository": "<b>you</b>/<b>you</b>",
  84       "script_version": "master",
  85       "script_parameters": {
  86         "input": {
  87           "output_of": "do_hash"
  88         }
  89       },
  90     }
  91   }
  92 }
  93 </pre></notextile>
  94
  95 This pipeline consists of three components.  The components "thing1" and "thing2" both depend on "cat_in_the_hat".  Once the "cat_in_the_hat" job is complete, both "thing1" and "thing2" can run in parallel, because they do not depend on each other.
  96
  97 <notextile><pre>
  98 {
  99   "name": "Wreck the house",
 100   "components": {
 101     "cat_in_the_hat": {
 102       "script": "cat.py",
 103       "repository": "<b>you</b>/<b>you</b>",
 104       "script_version": "master",
 105       "script_parameters": { }
 106     },
 107     "thing1": {
 108       "script": "thing1.py",
 109       "repository": "<b>you</b>/<b>you</b>",
 110       "script_version": "master",
 111       "script_parameters": {
 112         "input": {
 113           "output_of": "cat_in_the_hat"
 114         }
 115       },
 116     },
 117     "thing2": {
 118       "script": "thing2.py",
 119       "repository": "<b>you</b>/<b>you</b>",
 120       "script_version": "master",
 121       "script_parameters": {
 122         "input": {
 123           "output_of": "cat_in_the_hat"
 124         }
 125       },
 126     },
 127   }
 128 }
 129 </pre></notextile>
 130
 131 This pipeline consists of three components.  The component "cleanup" depends on "thing1" and "thing2".  Both "thing1" and "thing2" are started immediately and can run in parallel, because they do not depend on each other, but "cleanup" cannot begin until both "thing1" and "thing2" have completed.
 132
 133 <notextile><pre>
 134 {
 135   "name": "Clean the house",
 136   "components": {
 137     "thing1": {
 138       "script": "thing1.py",
 139       "repository": "<b>you</b>/<b>you</b>",
 140       "script_version": "master",
 141       "script_parameters": { }
 142     },
 143     "thing2": {
 144       "script": "thing2.py",
 145       "repository": "<b>you</b>/<b>you</b>",
 146       "script_version": "master",
 147       "script_parameters": { }
 148     },
 149     "cleanup": {
 150       "script": "cleanup.py",
 151       "repository": "<b>you</b>/<b>you</b>",
 152       "script_version": "master",
 153       "script_parameters": {
 154         "mess1": {
 155           "output_of": "thing1"
 156         },
 157         "mess2": {
 158           "output_of": "thing2"
 159         }
 160       }
 161     }
 162   }
 163 }
 164 </pre></notextile>
 165
 166 h2. Methods
 167
 168 h3. create
 169
 170 Create a new PipelineTemplate.
 171
 172 Arguments:
 173
 174 table(table table-bordered table-condensed).
 175 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 176 |pipeline_template|object||query||
 177
 178 h3. delete
 179
 180 Delete an existing PipelineTemplate.
 181
 182 Arguments:
 183
 184 table(table table-bordered table-condensed).
 185 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 186 {background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
 187
 188 h3. get
 189
 190 Gets a PipelineTemplate's metadata by UUID.
 191
 192 Arguments:
 193
 194 table(table table-bordered table-condensed).
 195 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 196 {background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
 197
 198 h3. list
 199
 200 List pipeline_templates.
 201
 202 Arguments:
 203
 204 table(table table-bordered table-condensed).
 205 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 206 |limit|integer (default 100)|Maximum number of pipeline_templates to return.|query||
 207 |order|string|Order in which to return matching pipeline_templates.|query||
 208 |filters|array|Conditions for filtering pipeline_templates.|query||
 209
 210 h3. update
 211
 212 Update attributes of an existing PipelineTemplate.
 213
 214 Arguments:
 215
 216 table(table table-bordered table-condensed).
 217 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 218 {background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
 219 |pipeline_template|object||query||