sdk/org.apache.airflow.sdk/Airflow/Dag

Dag

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Dag(val id: String = "", val to: String = "", val schedule: String = "", val queue: String = "", val description: String = "", val dagDisplayName: String = "", val docMd: String = "", val startDate: String = "", val endDate: String = "", val dagrunTimeout: String = "", val tags: Array<String> = [], val maxActiveTasks: Int = -1, val maxActiveRuns: Int = -1, val maxConsecutiveFailedDagRuns: Int = -1, val catchup: Boolean = false, val failFast: Boolean = false, val renderTemplateAsNativeObj: Boolean = false, val disableBundleVersioning: Boolean = false, val isPausedUponCreation: Boolean = false)

Annotation to automate a Dag-builder pattern.

When applied on a class Foo, this generates a FooBuilder class with a static build method to create the Dag structure automatically.

Configuration attributes are Airflow's own Dag settings; only attributes written explicitly at the use site are applied, so Airflow's own defaults apply to everything left out.

Properties

val catchup: Boolean = false

Airflow's catchup setting.

val dagDisplayName: String

Airflow's dag_display_name setting.

val dagrunTimeout: String

Airflow's dagrun_timeout setting; an ISO-8601 duration such as "PT5M".

val description: String

Airflow's description setting.

disableBundleVersioning

val disableBundleVersioning: Boolean = false

Airflow's disable_bundle_versioning setting.

val docMd: String

Airflow's doc_md setting.

val endDate: String

Airflow's end_date setting; an ISO-8601 date-time such as "2026-01-01T00:00:00Z".

val failFast: Boolean = false

Airflow's fail_fast setting.

Dag ID. Empty derives it from the annotated class's name.

isPausedUponCreation

val isPausedUponCreation: Boolean = false

Airflow's is_paused_upon_creation setting.

val maxActiveRuns: Int

Airflow's max_active_runs setting.

val maxActiveTasks: Int

Airflow's max_active_tasks setting.

maxConsecutiveFailedDagRuns

val maxConsecutiveFailedDagRuns: Int

Airflow's max_consecutive_failed_dag_runs setting.

val queue: String

Queue each task of the Dag runs on, unless the task sets its own queue. It cannot be blank.

renderTemplateAsNativeObj

val renderTemplateAsNativeObj: Boolean = false

Airflow's render_template_as_native_obj setting.

val schedule: String

"@once", "@continuous", a cron expression, or empty for no schedule.

val startDate: String

Airflow's start_date setting; an ISO-8601 date-time such as "2026-01-01T00:00:00Z".

val tags: Array<String>

Airflow's tags setting.

Name of the generated builder class. Empty derives <Class>Builder.