distributor.task_instance_batch
===============================

.. py:module:: distributor.task_instance_batch


Attributes
----------

.. autoapisummary::

   distributor.task_instance_batch.logger


Classes
-------

.. autoapisummary::

   distributor.task_instance_batch.TaskInstanceBatch


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

.. py:data:: logger

.. py:class:: TaskInstanceBatch(array_id: int, array_name: str, array_batch_num: int, task_resources_id: int, requester: jobmon.core.requester.Requester)

   
   Initialization of the TaskInstanceBatch object.


   .. py:attribute:: array_id


   .. py:attribute:: array_name


   .. py:attribute:: batch_number


   .. py:attribute:: task_resources_id


   .. py:attribute:: task_instances
      :type:  Set[jobmon.distributor.distributor_task_instance.DistributorTaskInstance]


   .. py:attribute:: requester


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



   .. py:property:: requested_resources
      :type: Dict



   .. py:method:: add_task_instance(task_instsance: jobmon.distributor.distributor_task_instance.DistributorTaskInstance) -> None


   .. py:method:: load_requested_resources() -> None


   .. py:method:: prepare_task_instance_batch_for_launch() -> None

      Add the current batch number to the current set of registered task instance ids.



   .. py:method:: set_distributor_ids(distributor_id_map: Dict) -> None

      Set the distributor_ids on the task instances in the array.

      :param distributor_id_map: map of array_step_id to distributor_id



   .. py:method:: transition_to_launched(next_report_by: float) -> None

      Transition all associated task instances to LAUNCHED state.



   .. py:method:: log_distributor_ids() -> None

      Log the distributor ID in the database for all task instances in the batch.



   .. py:method:: transition_to_killed() -> None

      Mark all TIs in this batch as killed in the DB (ERROR_FATAL).