distributor.distributor_task_instance
=====================================

.. py:module:: distributor.distributor_task_instance

.. autoapi-nested-parse::

   Task Instance object from the distributor's perspective.



Attributes
----------

.. autoapisummary::

   distributor.distributor_task_instance.logger


Classes
-------

.. autoapisummary::

   distributor.distributor_task_instance.DistributorTaskInstance


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

.. py:data:: logger

.. py:class:: DistributorTaskInstance(task_instance_id: int, workflow_run_id: int, status: str, requester: jobmon.core.requester.Requester)

   Object used for communicating with JSM from the distributor node.


   .. py:attribute:: task_instance_id


   .. py:attribute:: workflow_run_id


   .. py:attribute:: status


   .. py:attribute:: error_state
      :value: ''



   .. py:attribute:: error_msg
      :value: ''



   .. py:attribute:: requester


   .. py:property:: submission_name
      :type: str



   .. py:property:: batch
      :type: jobmon.distributor.task_instance_batch.TaskInstanceBatch


      Returns the batch the DistributorTaskInstance is in.


   .. py:property:: array_step_id
      :type: int


      Returns the array step of the TI.


   .. py:property:: distributor_id
      :type: str


      Returns the distributor id of the TI.


   .. py:method:: transition_to_launched(distributor_id: str, next_report_increment: float) -> None

      Register the submission of a new task instance to a cluster.

      This method is never called by the happy path - only if array submission is not
      implemented on a particular cluster type.



   .. py:method:: transition_to_no_distributor_id(no_id_err_msg: str) -> None

      Register that submission failed with the central service.

      :param no_id_err_msg: The error msg from the executor when failed to obtain distributor
                            id.



   .. py:method:: _transition_to_error(error_message: str, error_state: str) -> None

      Transitions the TaskInstance to the specified error state.



   .. py:method:: transition_to_unknown_error(error_message: str, error_state: str) -> Tuple[Set[DistributorTaskInstance], List]

      Register that an unknown error was discovered during reconciliation.



   .. py:method:: transition_to_resource_error(error_message: str, error_state: str) -> Tuple[Set[DistributorTaskInstance], List]

      Register that a resource error was discovered during reconciliation.



   .. py:method:: transition_to_error(error_message: str, error_state: str) -> Tuple[Set[DistributorTaskInstance], List]

      Register that a known error occurred during reconciliation.



   .. py:method:: __hash__() -> int

      Returns the id of the TaskInstance.



   .. py:method:: __eq__(other: object) -> bool

      Check if the hashes of two tasks are equivalent.



   .. py:method:: __lt__(other: DistributorTaskInstance) -> bool

      Check if one hash is less than the has of another Task.



   .. py:method:: __repr__() -> str

      Return a short representation string.