Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 2.07 KB

Workflow.md

File metadata and controls

45 lines (36 loc) · 2.07 KB

Workflow

A workflow instance and its steps.

Properties

Name Type Description Notes
completed_at datetime [optional]
context Dict[str, object] Accumulated step results, keyed by step name. Passed to downstream steps under the `_context` payload key. [optional]
created_at datetime
deadline_at datetime When the janitor fails the workflow if it is still running (set from `timeout_secs`; pushed forward by a retry). [optional]
error_message str Why the workflow ended `failed` or `cancelled`, when known (an upstream failure, a timeout, a user cancel). [optional]
id str
metadata Dict[str, object] [optional]
name str
parent_step_name str The parent's step that spawned this child. [optional]
parent_workflow_id str Set on a child workflow spawned by a sub-workflow step. [optional]
retry_count int How many times `POST /workflows/{id}/retry` re-ran this workflow. [optional]
started_at datetime [optional]
status WorkflowStatus
steps List[WorkflowStep]
tenant_id str [optional]
timeout_secs int The whole-workflow time budget it was created with, if any. [optional]

Example

from queueflow.models.workflow import Workflow

# TODO update the JSON string below
json = "{}"
# create an instance of Workflow from a JSON string
workflow_instance = Workflow.from_json(json)
# print the JSON string representation of the object
print(Workflow.to_json())

# convert the object into a dict
workflow_dict = workflow_instance.to_dict()
# create an instance of Workflow from a dict
workflow_from_dict = Workflow.from_dict(workflow_dict)

[Back to Model list] [Back to API list] [Back to README]