distributor.distributor_task_instance

Task Instance object from the distributor’s perspective.

Attributes

logger

Classes

DistributorTaskInstance

Object used for communicating with JSM from the distributor node.

Module Contents

distributor.distributor_task_instance.logger
class distributor.distributor_task_instance.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.

Initialization of distributor task instance.

Parameters:
  • task_instance_id (int) – a task_instance_id

  • workflow_run_id (int) – a workflow_run_id

  • status (str) – status of the distributor task instance

  • requester (Requester, optional) – a requester to communicate with the JSM. default is shared requester

task_instance_id
workflow_run_id
status
error_state = ''
error_msg = ''
requester
first_triage_time: float | None = None
triage_attempts: int = 0
property submission_name: str
property batch: jobmon.distributor.task_instance_batch.TaskInstanceBatch

Returns the batch the DistributorTaskInstance is in.

property array_step_id: int

Returns the array step of the TI.

property distributor_id: str

Returns the distributor id of the TI.

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.

transition_to_no_distributor_id(no_id_err_msg: str) None

Register that submission failed with the central service.

Parameters:

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

transition_to_unknown_error(error_message: str, error_state: str) Tuple[Set[DistributorTaskInstance], List]

Register that an unknown error was discovered during reconciliation.

transition_to_resource_error(error_message: str, error_state: str) Tuple[Set[DistributorTaskInstance], List]

Register that a resource error was discovered during reconciliation.

transition_to_error(error_message: str, error_state: str) Tuple[Set[DistributorTaskInstance], List]

Register that a known error occurred during reconciliation.