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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "pipeline_instances"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instances@
  15
  16 Object type: @d1hrv@
  17
  18 Example UUID: @zzzzz-d1hrv-0123456789abcde@
  19
  20 h2. Resource
  21
  22 Deprecated.  A pipeline instance is a collection of jobs managed by @aravdos-run-pipeline-instance@.
  23
  24 Each PipelineInstance has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute|_. Type|_. Description|_. Example|
  28 |pipeline_template_uuid|string|The "pipeline template":pipeline_templates.html that this instance was created from.||
  29 |name|string|||
  30 |components|hash|||
  31 |success|boolean|||
  32 |active|boolean|||
  33 |properties|Hash|||
  34
  35 h2. Methods
  36
  37 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  38
  39 Required arguments are displayed in %{background:#ccffcc}green%.
  40
  41 h3. create
  42
  43 Create a new PipelineInstance.
  44
  45 Arguments:
  46
  47 table(table table-bordered table-condensed).
  48 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  49 |pipeline_instance|object||query||
  50
  51 h3. delete
  52
  53 Delete an existing PipelineInstance.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  59 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  60
  61 h3. get
  62
  63 Gets a PipelineInstance's metadata by UUID.
  64
  65 Arguments:
  66
  67 table(table table-bordered table-condensed).
  68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  69 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  70
  71 h3. list
  72
  73 List pipeline_instances.
  74
  75 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  76
  77 h3. update
  78
  79 Update attributes of an existing PipelineInstance.
  80
  81 Arguments:
  82
  83 table(table table-bordered table-condensed).
  84 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  85 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  86 |pipeline_instance|object||query||