airflow.providers.standard.triggers.hitl¶

Classes¶

`HITLTriggerEventSuccessPayload`	Minimum required keys for a success Human-in-the-loop TriggerEvent.
`HITLTriggerEventFailurePayload`	Minimum required keys for a failed Human-in-the-loop TriggerEvent.
`HITLTrigger`	A trigger that checks whether Human-in-the-loop responses are received.

Module Contents¶

class airflow.providers.standard.triggers.hitl.HITLTriggerEventSuccessPayload[source]¶

Bases: TypedDict

Minimum required keys for a success Human-in-the-loop TriggerEvent.

chosen_options: list[str][source]¶

params_input: dict[str, Any][source]¶

class airflow.providers.standard.triggers.hitl.HITLTriggerEventFailurePayload[source]¶

Bases: TypedDict

Minimum required keys for a failed Human-in-the-loop TriggerEvent.

error: str[source]¶

error_type: Literal['timeout', 'unknown'][source]¶

class airflow.providers.standard.triggers.hitl.HITLTrigger(*, ti_id, options, params, defaults=None, multiple=False, timeout_datetime, poke_interval=5.0, **kwargs)[source]¶

Bases: airflow.triggers.base.BaseTrigger

A trigger that checks whether Human-in-the-loop responses are received.

ti_id[source]¶

poke_interval = 5.0[source]¶

options[source]¶

multiple = False[source]¶

defaults = None[source]¶

timeout_datetime[source]¶

params[source]¶

serialize()[source]¶

Serialize HITLTrigger arguments and classpath.

async run()[source]¶

Loop until the Human-in-the-loop response received or timeout reached.