| :py:mod:`airflow.example_dags.plugins.workday` |
| ============================================== |
| |
| .. py:module:: airflow.example_dags.plugins.workday |
| |
| .. autoapi-nested-parse:: |
| |
| Plugin to demonstrate timetable registration and accommodate example DAGs. |
| |
| |
| |
| Module Contents |
| --------------- |
| |
| Classes |
| ~~~~~~~ |
| |
| .. autoapisummary:: |
| |
| airflow.example_dags.plugins.workday.AfterWorkdayTimetable |
| airflow.example_dags.plugins.workday.WorkdayTimetablePlugin |
| |
| |
| |
| |
| .. py:class:: AfterWorkdayTimetable |
| |
| Bases: :py:obj:`airflow.timetables.base.Timetable` |
| |
| Protocol that all Timetable classes are expected to implement. |
| |
| .. py:method:: infer_manual_data_interval(run_after) |
| |
| When a DAG run is manually triggered, infer a data interval for it. |
| |
| This is used for e.g. manually-triggered runs, where ``run_after`` would |
| be when the user triggers the run. The default implementation raises |
| ``NotImplementedError``. |
| |
| |
| .. py:method:: next_dagrun_info(*, last_automated_data_interval, restriction) |
| |
| Provide information to schedule the next DagRun. |
| |
| The default implementation raises ``NotImplementedError``. |
| |
| :param last_automated_data_interval: The data interval of the associated |
| DAG's last scheduled or backfilled run (manual runs not considered). |
| :param restriction: Restriction to apply when scheduling the DAG run. |
| See documentation of :class:`TimeRestriction` for details. |
| |
| :return: Information on when the next DagRun can be scheduled. None |
| means a DagRun will not happen. This does not mean no more runs |
| will be scheduled even again for this DAG; the timetable can return |
| a DagRunInfo object when asked at another time. |
| |
| |
| |
| .. py:class:: WorkdayTimetablePlugin |
| |
| Bases: :py:obj:`airflow.plugins_manager.AirflowPlugin` |
| |
| Class used to define AirflowPlugin. |
| |
| .. py:attribute:: name |
| :annotation: = workday_timetable_plugin |
| |
| |
| |
| .. py:attribute:: timetables |
| |
| |
| |
| |
| |
