server.web.schemas.task
=======================

.. py:module:: server.web.schemas.task


Classes
-------

.. autoapisummary::

   server.web.schemas.task.TaskStatusRequest
   server.web.schemas.task.TaskStatusItem
   server.web.schemas.task.TaskStatusResponse
   server.web.schemas.task.TaskSubdagRequest
   server.web.schemas.task.TaskSubdagResponse
   server.web.schemas.task.TaskDependencyItem
   server.web.schemas.task.TaskDependenciesResponse
   server.web.schemas.task.TasksRecursiveRequest
   server.web.schemas.task.TasksRecursiveResponse
   server.web.schemas.task.TaskResourceUsageResponse
   server.web.schemas.task.DownstreamTasksResponse
   server.web.schemas.task.TaskInstanceDetailItem
   server.web.schemas.task.TaskInstanceDetailsResponse
   server.web.schemas.task.TaskDetailItem
   server.web.schemas.task.TaskDetailsResponse


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

.. py:class:: TaskStatusRequest

   Bases: :py:obj:`pydantic.BaseModel`


   Request model for task status queries.


   .. py:attribute:: task_ids
      :type:  Optional[Union[int, List[int]]]
      :value: None



   .. py:attribute:: status
      :type:  Optional[Union[str, List[str]]]
      :value: None



.. py:class:: TaskStatusItem

   Bases: :py:obj:`pydantic.BaseModel`


   Individual task status item.


   .. py:attribute:: TASK_ID
      :type:  int


   .. py:attribute:: task_status
      :type:  str


   .. py:attribute:: TASK_INSTANCE_ID
      :type:  int


   .. py:attribute:: DISTRIBUTOR_ID
      :type:  Optional[str]


   .. py:attribute:: STATUS
      :type:  str


   .. py:attribute:: RESOURCE_USAGE
      :type:  Optional[str]


   .. py:attribute:: STDOUT
      :type:  Optional[str]


   .. py:attribute:: STDERR
      :type:  Optional[str]


   .. py:attribute:: ERROR_TRACE
      :type:  Optional[str]


.. py:class:: TaskStatusResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for task status.


   .. py:attribute:: task_instance_status
      :type:  str


.. py:class:: TaskSubdagRequest

   Bases: :py:obj:`pydantic.BaseModel`


   Request model for task subdag.


   .. py:attribute:: task_ids
      :type:  List[int]


   .. py:attribute:: task_status
      :type:  Optional[List[str]]
      :value: []



.. py:class:: TaskSubdagResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for task subdag.


   .. py:attribute:: workflow_id
      :type:  Optional[int]


   .. py:attribute:: sub_task
      :type:  Optional[Dict[int, List[str]]]


.. py:class:: TaskDependencyItem

   Bases: :py:obj:`pydantic.BaseModel`


   Individual task dependency item.


   .. py:attribute:: id
      :type:  int


   .. py:attribute:: status
      :type:  str


   .. py:attribute:: name
      :type:  str


.. py:class:: TaskDependenciesResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for task dependencies.


   .. py:attribute:: up
      :type:  List[List[TaskDependencyItem]]


   .. py:attribute:: down
      :type:  List[List[TaskDependencyItem]]


.. py:class:: TasksRecursiveRequest

   Bases: :py:obj:`pydantic.BaseModel`


   Request model for recursive tasks.


   .. py:attribute:: task_ids
      :type:  List[int]


.. py:class:: TasksRecursiveResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for recursive tasks.


   .. py:attribute:: task_ids
      :type:  List[int]


.. py:class:: TaskResourceUsageResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for task resource usage.

   resource_usage is a 4-element list from
   SerializeTaskResourceUsage.to_wire():
   [num_attempts, nodename, runtime, memory]


   .. py:attribute:: resource_usage
      :type:  List[Union[int, str, None]]


.. py:class:: DownstreamTasksResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for downstream tasks.

   Each value is [node_id, downstream_node_ids] where
   downstream_node_ids is a list of ints (new clients) or
   a JSON string (legacy clients) or None.


   .. py:attribute:: downstream_tasks
      :type:  Dict[int, List[Union[int, List[int], str, None]]]


.. py:class:: TaskInstanceDetailItem

   Bases: :py:obj:`pydantic.BaseModel`


   Individual task instance detail item.


   .. py:attribute:: ti_id
      :type:  int


   .. py:attribute:: ti_status
      :type:  str


   .. py:attribute:: ti_stdout
      :type:  Optional[str]


   .. py:attribute:: ti_stderr
      :type:  Optional[str]


   .. py:attribute:: ti_stdout_log
      :type:  Optional[str]


   .. py:attribute:: ti_stderr_log
      :type:  Optional[str]


   .. py:attribute:: ti_distributor_id
      :type:  Optional[str]


   .. py:attribute:: ti_nodename
      :type:  Optional[str]


   .. py:attribute:: ti_error_log_description
      :type:  Optional[str]


   .. py:attribute:: ti_wallclock
      :type:  Optional[float]


   .. py:attribute:: ti_maxrss
      :type:  Optional[float]


   .. py:attribute:: ti_resources
      :type:  Optional[str]


   .. py:attribute:: ti_submit_date
      :type:  Optional[str]


   .. py:attribute:: ti_status_date
      :type:  Optional[str]


   .. py:attribute:: ti_queue_name
      :type:  Optional[str]


   .. py:attribute:: ti_cpu
      :type:  Optional[str]


   .. py:attribute:: ti_io
      :type:  Optional[str]


   .. py:attribute:: ti_workflow_run_id
      :type:  Optional[int]
      :value: None



.. py:class:: TaskInstanceDetailsResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for task instance details.


   .. py:attribute:: taskinstances
      :type:  List[TaskInstanceDetailItem]


.. py:class:: TaskDetailItem

   Bases: :py:obj:`pydantic.BaseModel`


   Individual task detail item.


   .. py:attribute:: task_status
      :type:  str


   .. py:attribute:: workflow_id
      :type:  int


   .. py:attribute:: task_name
      :type:  str


   .. py:attribute:: task_command
      :type:  str


   .. py:attribute:: task_status_date
      :type:  str


   .. py:attribute:: task_template_id
      :type:  int


   .. py:attribute:: num_attempts
      :type:  int


   .. py:attribute:: max_attempts
      :type:  int


.. py:class:: TaskDetailsResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for task details.


   .. py:attribute:: task_details
      :type:  List[TaskDetailItem]