m3resp.ProcessingRun#

class m3resp.ProcessingRun(*, processing_run_id=<factory>, name, kind='workflow', version=None, code_commit_hash=None, input_file_ids=<factory>, parameter_file_ids=<factory>, run_time=<factory>, operator_ref=None, status='succeeded', error=None, parameters=<factory>)[source]#

A stored record of a workflow, processing step or session action.

Variables:

processing_run_id (str) – Automatically generated identifier.
name (str) – Workflow, step or session-method name.
kind (ProcessingRunKind) – workflow, step or session_action; defaults to workflow.
version (str | None) – Optional workflow or operation version.
code_commit_hash (str | None) – Optional code revision used for the calculation.
input_file_ids (list[str]) – Identifiers of recorded input files.
parameter_file_ids (list[str]) – Identifiers of exported result-array files, such as per-breath pixel maps and masks.
run_time (float) – Unix timestamp in seconds; defaults to the current time.
operator_ref (str | None) – Optional reference to the person running the analysis.
status (ProcessingStatus) – pending, running, succeeded or failed; defaults to succeeded.
error (str | None) – Optional error message.
parameters (dict[str, Any]) – Processing settings and output provenance summaries.

Parameters:

processing_run_id (str)
name (str)
kind (Literal['workflow', 'step', 'session_action'])
version (str | None)
code_commit_hash (str | None)
input_file_ids (list[str])
parameter_file_ids (list[str])
run_time (float)
operator_ref (str | None)
status (Literal['pending', 'running', 'succeeded', 'failed'])
error (str | None)
parameters (dict[str, Any])

Attributes

`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`processing_run_id`
`name`
`kind`
`version`
`code_commit_hash`
`input_file_ids`
`parameter_file_ids`
`run_time`
`operator_ref`
`status`
`error`
`parameters`

code_commit_hash: str | None#

error: str | None#

input_file_ids: list[str]#

kind: ProcessingRunKind#

model_config = {'extra': 'forbid'}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str#

operator_ref: str | None#

parameter_file_ids: list[str]#

parameters: dict[str, Any]#

processing_run_id: str#

run_time: float#

status: ProcessingStatus#

version: str | None#