server.web.models.workflow
==========================

.. py:module:: server.web.models.workflow

.. autoapi-nested-parse::

   Workflow Database Table.



Attributes
----------

.. autoapisummary::

   server.web.models.workflow.logger


Classes
-------

.. autoapisummary::

   server.web.models.workflow.Workflow


Module Contents
---------------

.. py:data:: logger

.. py:class:: Workflow

   Bases: :py:obj:`jobmon.server.web.models.Base`


   Workflow Database Table.


   .. py:method:: to_wire_as_distributor_workflow() -> tuple

      Serialize workflow object.



   .. py:attribute:: id
      :type:  sqlalchemy.orm.Mapped[int]


   .. py:attribute:: tool_version_id


   .. py:attribute:: dag_id
      :type:  sqlalchemy.orm.Mapped[int]


   .. py:attribute:: workflow_args_hash


   .. py:attribute:: task_hash


   .. py:attribute:: description


   .. py:attribute:: name


   .. py:attribute:: workflow_args


   .. py:attribute:: max_concurrently_running
      :type:  sqlalchemy.orm.Mapped[int]


   .. py:attribute:: created_date


   .. py:attribute:: status_date


   .. py:attribute:: status
      :type:  sqlalchemy.orm.Mapped[str]


   .. py:attribute:: dag


   .. py:attribute:: workflow_runs


   .. py:attribute:: valid_transitions


   .. py:attribute:: untimely_transitions


   .. py:method:: transition(new_state: str) -> None

      Transition the state of the workflow.



   .. py:method:: link_workflow_run(workflow_run: jobmon.server.web.models.workflow_run.WorkflowRun, next_report_increment: float, dialect: str) -> Tuple

      Link a workflow run to this workflow.

      :param workflow_run: The workflow run to link
      :param next_report_increment: Number of seconds until next expected heartbeat
      :param dialect: The database dialect (mysql, sqlite)



   .. py:method:: reset(current_time: datetime.datetime) -> None

      Set a workflow to a resumable state.



   .. py:method:: resume(reset_running_jobs: bool) -> None

      Resume a workflow.



   .. py:property:: ready_to_link
      :type: bool


      Is this workflow able to link a new workflow run.


   .. py:property:: is_resumable
      :type: bool


      Is this workflow resumable.