server.web.routes.v3.fsm.task
=============================

.. py:module:: server.web.routes.v3.fsm.task

.. autoapi-nested-parse::

   Routes for Tasks.



Attributes
----------

.. autoapisummary::

   server.web.routes.v3.fsm.task.logger
   server.web.routes.v3.fsm.task.DIALECT


Functions
---------

.. autoapisummary::

   server.web.routes.v3.fsm.task.bind_tasks_no_args
   server.web.routes.v3.fsm.task.bind_task_args
   server.web.routes.v3.fsm.task.bind_task_attributes
   server.web.routes.v3.fsm.task._add_or_get_attribute_types
   server.web.routes.v3.fsm.task.bind_task_resources
   server.web.routes.v3.fsm.task.get_most_recent_ti_error
   server.web.routes.v3.fsm.task.set_task_resume_state


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

.. py:data:: logger

.. py:data:: DIALECT

.. py:function:: bind_tasks_no_args(request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Bind the task objects to the database.


.. py:function:: bind_task_args(request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Add task args and associated task ids to the database.


.. py:function:: bind_task_attributes(request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Add task attributes and associated attribute types to the database.


.. py:function:: _add_or_get_attribute_types(names: Union[List[str], Set[str]], db: sqlalchemy.orm.Session) -> Dict[str, int]

.. py:function:: bind_task_resources(request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Add the task resources for a given task.


.. py:function:: get_most_recent_ti_error(task_id: int, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any

   Route to determine the cause of the most recent task_instance's error.

   :param task_id: the ID of the task.
   :type task_id: int
   :param db: The database session.

   :returns: error message


.. py:function:: set_task_resume_state(workflow_id: int, request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   An endpoint to set all tasks to a resumable state for a workflow.

   Conditioned on the workflow already being in an appropriate resume state.