flowserv.view.run module

Serializer for workflow runs.

class flowserv.view.run.RunSerializer

Bases: object

Serializer for workflow runs.

run_descriptor(run: flowserv.model.base.RunObject) → Dict

Get serialization for a run descriptor. The descriptor contains the run identifier, state, timestampls, and the base list of HATEOAS references.

Parameters

run (flowserv.model.base.RunObject) – Run decriptor

Return type

dict

run_handle(run: flowserv.model.base.RunObject, group: Optional[flowserv.model.base.GroupObject] = None) → Dict

Get serialization for a run handle. The run handle extends the run descriptor with the run arguments, the parameter declaration taken from the workflow group handle (since it may differ from the parameter list of the workflow), and additional information associated with the run state.

Parameters

• run (flowserv.model.base.RunObject) – Workflow run handle

• group (flowserv.model.base.GroupObject, default=None) – Workflow group handle. Missing for post-processing workflows

Return type

dict

run_listing(runs: List[flowserv.model.base.RunObject]) → Dict

Get serialization for a list of run handles.

Parameters

runs (list(flowserv.model.base.RunObject)) – List of run handles

Return type

dict