DagSpec

interface DagSpec extends GeneratedDagFields { catchup?: boolean; dagDisplayName?: string; dagrunTimeout?: number; description?: string; disableBundleVersioning?: boolean; docMd?: string; endDate?: Date; failFast?: boolean; isPausedUponCreation?: boolean; maxActiveRuns?: number; maxActiveTasks?: number; maxConsecutiveFailedDagRuns?: number; queue?: string; renderTemplateAsNativeObj?: boolean; schedule?: string; startDate?: Date; tags?: readonly string[]; }

Source: dag.ts:107

Dag-level options: the schedule, the tags, how many runs may be active, and the rest of what DAG(...) takes in Python.

Every field is optional, so {} stays valid and a field added later cannot break a call site. An unknown key is rejected, so a misspelled field is an error rather than a Dag that quietly ignores it.

queue is the one hand-written field: Airflow's schema has no Dag-level queue, but every task of a native Dag runs on the same coordinator, so the queue that routes them there belongs on the Dag rather than on each task.

Hierarchy

  • GeneratedDagFields
  • DagSpec

Properties

catchup: boolean

Inherited from catchup

Maps to the schema key catchup.

dagDisplayName: string

Inherited from dagDisplayName

Maps to the schema key dag_display_name.

dagrunTimeout: number

Inherited from dagrunTimeout

Maps to the schema key dagrun_timeout, in seconds.

description: string

Inherited from description

Maps to the schema key description.

disableBundleVersioning: boolean

Inherited from disableBundleVersioning

Maps to the schema key disable_bundle_versioning.

docMd: string

Inherited from docMd

Maps to the schema key doc_md.

endDate: Date

Inherited from endDate

Maps to the schema key end_date.

failFast: boolean

Inherited from failFast

Maps to the schema key fail_fast (schema default false).

isPausedUponCreation: boolean

Inherited from isPausedUponCreation

Maps to the schema key is_paused_upon_creation.

maxActiveRuns: number

Inherited from maxActiveRuns

Maps to the schema key max_active_runs.

maxActiveTasks: number

Inherited from maxActiveTasks

Maps to the schema key max_active_tasks.

maxConsecutiveFailedDagRuns: number

Inherited from maxConsecutiveFailedDagRuns

Maps to the schema key max_consecutive_failed_dag_runs.

queue: string

readonly
dag.ts:116

Queue the Dag's tasks run on, unless a task names its own.

A native Dag's tasks are executed by the Node coordinator, which the deployment's queue_to_coordinator maps a queue to, so this is what routes them there. queue on a TaskSpec wins for that task. A queue that is set cannot be blank.

renderTemplateAsNativeObj: boolean

Inherited from renderTemplateAsNativeObj

Maps to the schema key render_template_as_native_obj (schema default false).

schedule: string

Inherited from schedule

When the Dag runs: "@once", "@continuous", a cron expression, or unset for no schedule. The serializer lowers it onto the schema's timetable object.

startDate: Date

Inherited from startDate

Maps to the schema key start_date.

tags: readonly string[]

Inherited from tags

Maps to the schema key tags.