core.constants
==============

.. py:module:: core.constants

.. autoapi-nested-parse::

   Constants declared for different statuses, types and codes throughout Jobmon.



Classes
-------

.. autoapisummary::

   core.constants.ArgType
   core.constants.TaskResourcesType
   core.constants.TaskInstanceStatus
   core.constants.TaskStatus
   core.constants.WorkflowRunStatus
   core.constants.WorkflowStatus
   core.constants.Direction
   core.constants.SpecialChars
   core.constants.ExecludeTTVs
   core.constants.MaxConcurrentlyRunning


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

.. py:class:: ArgType

   .. py:attribute:: NODE_ARG
      :value: 1



   .. py:attribute:: TASK_ARG
      :value: 2



   .. py:attribute:: OP_ARG
      :value: 3



.. py:class:: TaskResourcesType

   Constant Types for Task Resources.


   .. py:attribute:: ORIGINAL
      :value: 'O'



   .. py:attribute:: VALIDATED
      :value: 'V'



   .. py:attribute:: ADJUSTED
      :value: 'A'



.. py:class:: TaskInstanceStatus

   Statuses used for Task Instances.


   .. py:attribute:: DONE
      :value: 'D'



   .. py:attribute:: ERROR
      :value: 'E'



   .. py:attribute:: ERROR_FATAL
      :value: 'F'



   .. py:attribute:: INSTANTIATED
      :value: 'I'



   .. py:attribute:: KILL_SELF
      :value: 'K'



   .. py:attribute:: LAUNCHED
      :value: 'O'



   .. py:attribute:: QUEUED
      :value: 'Q'



   .. py:attribute:: RUNNING
      :value: 'R'



   .. py:attribute:: TRIAGING
      :value: 'T'



   .. py:attribute:: SUBMITTED_TO_BATCH_DISTRIBUTOR
      :value: 'B'



   .. py:attribute:: UNKNOWN_ERROR
      :value: 'U'



   .. py:attribute:: NO_DISTRIBUTOR_ID
      :value: 'W'



   .. py:attribute:: NO_HEARTBEAT
      :value: 'X'



   .. py:attribute:: RESOURCE_ERROR
      :value: 'Z'



.. py:class:: TaskStatus

   Statuses used for Tasks.


   .. py:attribute:: REGISTERING
      :value: 'G'



   .. py:attribute:: QUEUED
      :value: 'Q'



   .. py:attribute:: INSTANTIATING
      :value: 'I'



   .. py:attribute:: LAUNCHED
      :value: 'O'



   .. py:attribute:: RUNNING
      :value: 'R'



   .. py:attribute:: DONE
      :value: 'D'



   .. py:attribute:: ERROR_RECOVERABLE
      :value: 'E'



   .. py:attribute:: ADJUSTING_RESOURCES
      :value: 'A'



   .. py:attribute:: ERROR_FATAL
      :value: 'F'



   .. py:attribute:: LABEL_DICT


.. py:class:: WorkflowRunStatus

   Statuses used for Workflow Runs.


   .. py:attribute:: REGISTERED
      :value: 'G'



   .. py:attribute:: LINKING
      :value: 'L'



   .. py:attribute:: BOUND
      :value: 'B'



   .. py:attribute:: ABORTED
      :value: 'A'



   .. py:attribute:: RUNNING
      :value: 'R'



   .. py:attribute:: DONE
      :value: 'D'



   .. py:attribute:: STOPPED
      :value: 'S'



   .. py:attribute:: ERROR
      :value: 'E'



   .. py:attribute:: COLD_RESUME
      :value: 'C'



   .. py:attribute:: HOT_RESUME
      :value: 'H'



   .. py:attribute:: TERMINATED
      :value: 'T'



   .. py:attribute:: INSTANTIATED
      :value: 'I'



   .. py:attribute:: LAUNCHED
      :value: 'O'



.. py:class:: WorkflowStatus

   Statuses used for Workflows.


   .. py:attribute:: REGISTERING
      :value: 'G'



   .. py:attribute:: QUEUED
      :value: 'Q'



   .. py:attribute:: ABORTED
      :value: 'A'



   .. py:attribute:: INSTANTIATING
      :value: 'I'



   .. py:attribute:: LAUNCHED
      :value: 'O'



   .. py:attribute:: RUNNING
      :value: 'R'



   .. py:attribute:: DONE
      :value: 'D'



   .. py:attribute:: HALTED
      :value: 'H'



   .. py:attribute:: FAILED
      :value: 'F'



.. py:class:: Direction

   Bases: :py:obj:`enum.Enum`


   A generic utility class.

   Used to represent one-dimensional direction,
   such as upstream/downstream.


   .. py:attribute:: UP
      :value: 'up'



   .. py:attribute:: DOWN
      :value: 'down'



.. py:class:: SpecialChars

   A generic utility class.

   Used to define special chars.


   .. py:attribute:: ILLEGAL_SPECIAL_CHARACTERS
      :value: '/\\\\\'\\" '



.. py:class:: ExecludeTTVs

   A hard-coded list.

   Used to exclude task template versions with huge tasks that cause DB crash.


   .. py:attribute:: EXECLUDE_TTVS


.. py:class:: MaxConcurrentlyRunning

   A hard limit of array concurrency.

   Currently set to max int, but can change as INFRA requests.


   .. py:attribute:: MAXCONCURRENTLYRUNNING
      :value: 2147483647