WorkflowQueue

class caliber.WorkflowQueue(**kwargs)[source]

A queue for Workflows.

delete_workload(workload_id: str, project_id: str | None = None, model_name: str | None = None) → None[source]

Delete a Workload from the WorkflowQueue.

Parameters:

  • workload_id (str) – The ID of the Workload to delete.

  • project_id (Optional[str]) – The ID of the Speckle project.

  • model_name (Optional[str]) – The name of the model. The default name is ‘caliber’.

reset_run_secret(workload_id: str, project_id: str | None = None, model_name: str | None = None) → None[source]

Reset the run secret of a Workload in the WorkflowQueue.

Note

This method is only relevant if a remote queue is used.

Parameters:

  • workload_id (str) – The ID of the Workload to reset.

  • project_id (Optional[str]) – The ID of the Speckle project.

  • model_name (Optional[str]) – The name of the model. The default name is ‘caliber’.

view_workload(workload_id: str) → None[source]

View a Workload in the WorkflowQueue.

Parameters:

workload_id (str) – The ID of the Workload to view.

list_workloads(ignore_completed: bool = False, ignore_not_completed: bool = False) → None[source]

List the Workloads in the WorkflowQueue.

Parameters:

  • ignore_completed (bool) – Do not list completed Workloads.

  • ignore_not_completed (bool) – Do not list not completed Workloads.

send_and_create_version(message: str, project_id: str | None = None, model_name: str | None = None)[source]

Save the WorkflowQueue.

If a local workflow queue is set up, the WorkflowQueue will be saved in the local Speckle database, and the object id is stored in ‘.caliberwfqueue’. If a remote workflow queue is set up, the WorkflowQueue is sent to the Speckle Server and a version is created.

Parameters:

  • message (str) – The message to attach to the version.

  • project_id (Optional[str]) – The ID of the project.

  • model_name (Optional[str]) – The name of the model to create a new version on. The default name is ‘caliber’.