airflow_pydantic.DagArgs¶

pydantic model airflow_pydantic.DagArgs[source]¶

Bases: BaseModel

field description: str | None = None¶: The description for the DAG to e.g. be shown on the webserver

field schedule: timedelta | Literal['NOTSET'] | str | None | CronDataIntervalTimetable | CronTriggerTimetable | MultipleCronTriggerTimetable | EventsTimetable | DeltaDataIntervalTimetable | DeltaTriggerTimetable = None¶: Defines the rules according to which DAG runs are scheduled. Can accept cron string, timedelta object, Timetable, or list of Dataset objects. If this is not provided, the DAG will be set to the default schedule timedelta(days=1). See also Customizing DAG Scheduling with Timetables.

field start_date: Annotated[datetime | tuple[datetime, str], AfterValidator(func=_datetime_or_datetime_and_timezone)] | None = None¶: The timestamp from which the scheduler will attempt to backfill

field end_date: Annotated[datetime | tuple[datetime, str], AfterValidator(func=_datetime_or_datetime_and_timezone)] | None = None¶: A date beyond which your DAG won’t run, leave to None for open-ended scheduling

field default_args: TaskArgs | None = None¶: Default arguments for tasks in the DAG

field max_active_tasks: int | None = None¶: the number of task instances allowed to run concurrently

field max_active_runs: int | None = None¶: maximum number of active DAG runs, beyond this number of DAG runs in a running state, the scheduler won’t create new active DAG runs

field default_view: Literal['grid', 'graph', 'duration', 'gantt', 'landing_times'] | None = None¶: Specify DAG default view (grid, graph, duration, gantt, landing_times), default grid

field orientation: Literal['LR', 'TB', 'RL', 'BT'] | None = None¶: Specify DAG orientation in graph view (LR, TB, RL, BT), default LR

field catchup: bool | None = None¶: Perform scheduler catchup (or only run latest)? Defaults to False

field doc_md: str | None = None¶: Markdown formatted documentation for the DAG. This will be rendered in the UI.

field params: dict[str, Annotated[Param, ParamType]] | None = None¶: A dictionary of DAG-level parameters that are made accessible in templates, namespaced under params. These params can be overridden at the task level.

field is_paused_upon_creation: bool | None = None¶: Specifies if the dag is paused when created for the first time. If the dag exists already, this flag will be ignored.

field tags: list[str] | None = None¶: List of tags to help filtering DAGs in the UI.

field dag_display_name: str | None = None¶: The display name of the DAG which appears on the UI.