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