mantlebio.core.pipeline_run.client module#

class mantlebio.core.pipeline_run.client.PipelineRunClient(session, storage_client, dataset_client)[source]#

Bases: object

PipelineRunClient object for making pipeline run requests to the Mantle API

get(id)[source]#
Return type:

_IPipelineRun

kickoff(pipeline_id, version, input=None, external=False)[source]#
Return type:

_IPipelineRun

kickoff_run(pipeline_id, version, input=None, external=False)[source]#

Create a new Pipeline Run

Parameters:

  • id (str) – Pipeline ID

  • version (str) – Pipeline Version

  • input (dict, optional) – Pipeline Run inputs

Returns:

PipelineRun object

Return type:

PipelineRun

Note: Will be deprecated in version 2.0.0 in favor of kickoff()

load_run(id)[source]#

Load an existing Pipeline Run

Parameters:

id (str) – Pipeline ID

Returns:

PipelineRun object

Return type:

PipelineRun

Note: Will be deprecated in version 2.0.0 in favor of pipeline_run.get()

update_status(id, status)[source]#