flowserv.view.group module

Serializer for workflow user groups.

class flowserv.view.group.WorkflowGroupSerializer(files: Optional[flowserv.view.files.UploadFileSerializer] = None, runs: Optional[flowserv.view.run.RunSerializer] = None)

Bases: object

Default serializer for workflow user groups.

group_descriptor(group: flowserv.model.base.GroupObject) → Dict

Get serialization for a workflow group descriptor. The descriptor contains the group identifier, name, and the base list of HATEOAS references.

Parameters

group (flowserv.model.base.GroupObject) – Workflow group handle

Return type

dict

group_handle(group: flowserv.model.base.GroupObject, runs: Optional[List[flowserv.model.base.RunObject]] = None) → Dict

Get serialization for a workflow group handle.

Parameters

• group (flowserv.model.base.GroupObject) – Workflow group handle

• runs (list of flowserv.model.base.RunObject, default=None) – Optional list of run handles for an authenticated user.

Return type

dict

group_listing(groups: List[flowserv.model.base.GroupObject]) → Dict

Get serialization of a workflow group descriptor list.

Parameters

groups (list(flowserv.model.base.GroupObject)) – List of descriptors for workflow groups

Return type

dict