def cancel(workflow_id: str) -> None:
"""Cancel a workflow.
Args:
workflow_id: The workflow to cancel.
Examples:
>>> workflow_step = some_job.step()
>>> output = workflow_step.run_async(workflow_id="some_job")
>>> workflow.cancel(workflow_id="some_job")
>>> assert [("some_job", workflow.CANCELED)] == workflow.list_all()
Returns:
None
"""
ensure_ray_initialized()
if not isinstance(workflow_id, str):
raise TypeError("workflow_id has to be a string type.")
return execution.cancel(workflow_id)
def cancel(workflow_id: str) -> None:
"""Cancel a workflow. Workflow checkpoints will still be saved in storage. To
clean up saved checkpoints, see `workflow.delete()`.
Args:
workflow_id: The workflow to cancel.
Examples:
>>> workflow_step = some_job.step()
>>> output = workflow_step.run_async(workflow_id="some_job")
>>> workflow.cancel(workflow_id="some_job")
>>> assert [("some_job", workflow.CANCELED)] == workflow.list_all()
Returns:
None
"""
ensure_ray_initialized()
if not isinstance(workflow_id, str):
raise TypeError("workflow_id has to be a string type.")
return execution.cancel(workflow_id)
