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 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_instances@
  12
  13 UUID type: @d1hrv@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 Deprecated.  A pipeline instance is a collection of jobs managed by @aravdos-run-pipeline-instance@.
  20
  21 Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Example|
  25 |pipeline_template_uuid|string|||
  26 |name|string|||
  27 |components|hash|||
  28 |success|boolean|||
  29 |active|boolean|||
  30 |properties|Hash|||
  31
  32 h2. Methods
  33
  34 h3. create
  35
  36 Create a new PipelineInstance.
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 |pipeline_instance|object||query||
  43
  44 h3. delete
  45
  46 Delete an existing PipelineInstance.
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  53
  54 h3. get
  55
  56 Gets a PipelineInstance's metadata by UUID.
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  63
  64 h3. list
  65
  66 List pipeline_instances.
  67
  68 Arguments:
  69
  70 table(table table-bordered table-condensed).
  71 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  72 |limit|integer (default 100)|Maximum number of pipeline_instances to return.|query||
  73 |order|string|Order in which to return matching pipeline_instances.|query||
  74 |filters|array|Conditions for filtering pipeline_instances.|query||
  75
  76 h3. update
  77
  78 Update attributes of an existing PipelineInstance.
  79
  80 Arguments:
  81
  82 table(table table-bordered table-condensed).
  83 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  84 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  85 |pipeline_instance|object||query||