PipelineScheduledRun

class previsionio.pipeline.PipelineScheduledRun(_id: str, name: str, project_id: str, pipeline_template_id: Dict, nodes_properties: List, exec_type: str, enabled: bool, description: str = None, draft: bool = True, created_at: str = None, **kwargs)

Bases: previsionio.api_resource.ApiResource

classmethod from_id(_id: str) → previsionio.pipeline.PipelineScheduledRun

Get a pipeline scheduled run from the platform by its unique id.

Parameters:_id (str) – Unique id of the pipeline scheduled run to retrieve Returns:Fetched experiment Return type:PipelineScheduledRun Raises:PrevisionException – Any error while fetching data from the platform or parsing result

get_executions(limit: int = 15)

Get executions of a pipeline scheduled run.

Parameters:limit (int) – Number of executions to retrieve. Returns:list(dict)

classmethod list(project_id: str, all: bool = True)

List all the available pipeline scheduled runs in the current active [client] workspace.

Warning

Contrary to the parent list() function, this method returns actual Dataset objects rather than plain dictionaries with the corresponding data.

Parameters:

• project_id (str) – Unique reference of the project id on the platform
• all (boolean, optional) – Whether to force the SDK to load all items of the given type (by calling the paginated API several times). Else, the query will only return the first page of result.

Returns:

Fetched dataset objects

Return type:

list(PipelineScheduledRun)

trigger()

Trigger an execution of a pipeline scheduled run.