airflow_supervisor.AirflowConfiguration

pydantic model airflow_supervisor.AirflowConfiguration

Bases: _BaseCfgModel

Settings that MUST be set when running in airflow

Show JSON schema

{
   "title": "AirflowConfiguration",
   "description": "Settings that MUST be set when running in airflow",
   "type": "object",
   "properties": {
      "check_interval": {
         "default": "PT5S",
         "description": "Interval between supervisor program status checks",
         "format": "duration",
         "title": "Check Interval",
         "type": "string"
      },
      "check_timeout": {
         "default": "PT8H",
         "description": "Timeout to wait for supervisor program status checks",
         "format": "duration",
         "title": "Check Timeout",
         "type": "string"
      },
      "runtime": {
         "anyOf": [
            {
               "format": "duration",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Max runtime of Supervisor job",
         "title": "Runtime"
      },
      "endtime": {
         "anyOf": [
            {
               "format": "time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "End time of Supervisor job",
         "title": "Endtime"
      },
      "maxretrigger": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Max number of retriggers of Supervisor job (e.g. max number of checks separated by `check_interval`)",
         "title": "Maxretrigger"
      },
      "reference_date": {
         "default": "data_interval_end",
         "description": "Reference date for the job. NOTE: Airflow schedules after end of date interval, so `data_interval_end` is the default",
         "enum": [
            "start_date",
            "logical_date",
            "data_interval_end"
         ],
         "title": "Reference Date",
         "type": "string"
      }
   }
}

Fields:

• check_interval (datetime.timedelta)

• check_timeout (datetime.timedelta)

• endtime (datetime.time | None)

• maxretrigger (int | None)

• reference_date (Literal['start_date', 'logical_date', 'data_interval_end'])

• runtime (datetime.timedelta | None)

field check_interval: timedelta = datetime.timedelta(seconds=5)

Interval between supervisor program status checks

field check_timeout: timedelta = datetime.timedelta(seconds=28800)

Timeout to wait for supervisor program status checks

field runtime: timedelta | None = None

Max runtime of Supervisor job

field endtime: time | None = None

End time of Supervisor job

field maxretrigger: int | None = None

Max number of retriggers of Supervisor job (e.g. max number of checks separated by check_interval)

field reference_date: Literal['start_date', 'logical_date', 'data_interval_end'] = 'data_interval_end'

Reference date for the job. NOTE: Airflow schedules after end of date interval, so data_interval_end is the default