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