airflow.operators.trigger_dagrun
¶
Module Contents¶
-
class
airflow.operators.trigger_dagrun.
TriggerDagRunLink
[source]¶ Bases:
airflow.models.BaseOperatorLink
Operator link for TriggerDagRunOperator. It allows users to access DAG triggered by task using TriggerDagRunOperator.
-
class
airflow.operators.trigger_dagrun.
TriggerDagRunOperator
(*, trigger_dag_id: str, trigger_run_id: Optional[str] = None, conf: Optional[Dict] = None, execution_date: Optional[Union[str, datetime.datetime]] = None, reset_dag_run: bool = False, wait_for_completion: bool = False, poke_interval: int = 60, allowed_states: Optional[List] = None, failed_states: Optional[List] = None, **kwargs)[source]¶ Bases:
airflow.models.BaseOperator
Triggers a DAG run for a specified
dag_id
- Parameters
trigger_dag_id (str) – The dag_id to trigger (templated).
trigger_run_id (str) – The run ID to use for the triggered DAG run (templated). If not provided, a run ID will be automatically generated.
conf (dict) – Configuration for the DAG run.
execution_date (str or datetime.datetime) – Execution date for the dag (templated).
reset_dag_run (bool) – Whether or not clear existing dag run if already exists. This is useful when backfill or rerun an existing dag run. When reset_dag_run=False and dag run exists, DagRunAlreadyExists will be raised. When reset_dag_run=True and dag run exists, existing dag run will be cleared to rerun.
wait_for_completion (bool) – Whether or not wait for dag run completion. (default: False)
poke_interval (int) – Poke interval to check dag run status when wait_for_completion=True. (default: 60)
allowed_states (list) – List of allowed states, default is
['success']
.failed_states (list) – List of failed or dis-allowed states, default is
None
.