projects
/
arvados.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
10346: Add session establishment diagram. Clarify role of block signatures.
[arvados.git]
/
doc
/
api
/
methods
/
pipeline_instances.html.textile.liquid
diff --git
a/doc/api/methods/pipeline_instances.html.textile.liquid
b/doc/api/methods/pipeline_instances.html.textile.liquid
index eb0574a0c63efbfc42f38b40f20c328a6bb34d76..f4fb774cf48d3bc921877816f9d6ee155e5b9433 100644
(file)
--- a/
doc/api/methods/pipeline_instances.html.textile.liquid
+++ b/
doc/api/methods/pipeline_instances.html.textile.liquid
@@
-6,44
+6,46
@@
title: "pipeline_instances"
...
...
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instances@
+Object type: @d1hrv@
-Required arguments are displayed in %{background:#ccffcc}green%.
-
+Example UUID: @zzzzz-d1hrv-0123456789abcde@
-h2.
creat
e
+h2.
Resourc
e
-
Create a new PipelineInstance
.
+
Deprecated. A pipeline instance is a collection of jobs managed by @aravdos-run-pipeline-instance@
.
-
Arguments
:
+
Each PipelineInstance has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html
:
table(table table-bordered table-condensed).
table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|pipeline_instance|object||query||
+|_. Attribute|_. Type|_. Description|_. Example|
+|pipeline_template_uuid|string|The "pipeline template":pipeline_templates.html that this instance was created from.||
+|name|string|||
+|components|hash|||
+|success|boolean|||
+|active|boolean|||
+|properties|Hash|||
-h2.
delete
+h2.
Methods
-
Delete an existing PipelineInstance
.
+
See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@
.
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
+Required arguments are displayed in %{background:#ccffcc}green%.
-h
2. destroy
+h
3. create
-destroy pipeline_instances
+Create a new PipelineInstance.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-
{background:#ccffcc}.|uuid|string||path
||
+
|pipeline_instance|object||query
||
-h
2. get
+h
3. delete
-
Gets a PipelineInstance's metadata by UUID
.
+
Delete an existing PipelineInstance
.
Arguments:
Arguments:
@@
-51,29
+53,23
@@
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
-h
2. lis
t
+h
3. ge
t
-
List pipeline_instances
.
+
Gets a PipelineInstance's metadata by UUID
.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|limit|integer (default 100)|Maximum number of pipeline_instances to return.|query||
-|order|string|Order in which to return matching pipeline_instances.|query||
-|filters|array|Conditions for filtering pipeline_instances.|query||
-
-h2. show
+{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
-show pipeline_instances
+h3. list
-Arguments:
+List pipeline_instances.
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index
-h
2
. update
+h
3
. update
Update attributes of an existing PipelineInstance.
Update attributes of an existing PipelineInstance.