pipeline_instances

API endpoint base: https://pirca.arvadosapi.com/arvados/v1/pipeline_instances

Object type: d1hrv

Example UUID: zzzzz-d1hrv-0123456789abcde

Resource

Deprecated. A pipeline instance is a collection of jobs managed by aravdos-run-pipeline-instance.

Each PipelineInstance has, in addition to the Common resource fields:

Attribute	Type	Description	Example
pipeline_template_uuid	string	The pipeline template that this instance was created from.
name	string
components	hash
success	boolean
active	boolean
properties	Hash

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new PipelineInstance.

Arguments:

Argument	Type	Description	Location	Example
pipeline_instance	object		query

delete

Delete an existing PipelineInstance.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the PipelineInstance in question.	path

get

Gets a PipelineInstance’s metadata by UUID.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the PipelineInstance in question.	path

list

List pipeline_instances.

See common resource list method.

update

Update attributes of an existing PipelineInstance.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the PipelineInstance in question.	path
pipeline_instance	object		query

---

Previous: job_tasks Next: pipeline_templates