TaskSpec

interface TaskSpec extends GeneratedTaskFields { dependsOnPast?: boolean; docMd?: string; doXcomPush?: boolean; emailOnFailure?: boolean; emailOnRetry?: boolean; endDate?: Date; executionTimeout?: number; executor?: string; ignoreFirstDependsOnPast?: boolean; mapIndexTemplate?: string; maxActiveTisPerDag?: number; maxActiveTisPerDagrun?: number; maxRetryDelay?: number; owner?: string; pool?: string; poolSlots?: number; priorityWeight?: number; queue?: string; retries?: number; retryDelay?: number; retryExponentialBackoff?: number; startDate?: Date; taskId?: string; triggerRule?: string; waitForDownstream?: boolean; waitForPastDependsBeforeSkipping?: boolean; weightRule?: string; }

Source: dag.ts:126

Task-level options: the retries, the pool, the trigger rule, and the rest of what an operator takes in Python.

The task id is here too, for a handler whose id is not given positionally. Optional and record-only on the same terms as DagSpec.

Hierarchy

  • GeneratedTaskFields
  • TaskSpec

Properties

dependsOnPast: boolean

Inherited from dependsOnPast

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

docMd: string

Inherited from docMd

Maps to the schema key doc_md.

doXcomPush: boolean

Inherited from doXcomPush

Maps to the schema key do_xcom_push (schema default true).

emailOnFailure: boolean

Inherited from emailOnFailure

Maps to the schema key email_on_failure (schema default true).

emailOnRetry: boolean

Inherited from emailOnRetry

Maps to the schema key email_on_retry (schema default true).

endDate: Date

Inherited from endDate

Maps to the schema key end_date.

executionTimeout: number

Inherited from executionTimeout

Maps to the schema key execution_timeout, in seconds.

executor: string

Inherited from executor

Maps to the schema key executor.

ignoreFirstDependsOnPast: boolean

Inherited from ignoreFirstDependsOnPast

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

mapIndexTemplate: string

Inherited from mapIndexTemplate

Maps to the schema key map_index_template.

maxActiveTisPerDag: number

Inherited from maxActiveTisPerDag

Maps to the schema key max_active_tis_per_dag.

maxActiveTisPerDagrun: number

Inherited from maxActiveTisPerDagrun

Maps to the schema key max_active_tis_per_dagrun.

maxRetryDelay: number

Inherited from maxRetryDelay

Maps to the schema key max_retry_delay, in seconds.

owner: string

Inherited from owner

Maps to the schema key owner (schema default "airflow").

pool: string

Inherited from pool

Maps to the schema key pool (schema default "default_pool").

poolSlots: number

Inherited from poolSlots

Maps to the schema key pool_slots (schema default 1).

priorityWeight: number

Inherited from priorityWeight

Maps to the schema key priority_weight (schema default 1).

queue: string

Inherited from queue

Maps to the schema key queue (schema default "default").

retries: number

Inherited from retries

Maps to the schema key retries (schema default 0).

retryDelay: number

Inherited from retryDelay

Maps to the schema key retry_delay, in seconds (schema default 300).

retryExponentialBackoff: number

Inherited from retryExponentialBackoff

Maps to the schema key retry_exponential_backoff (schema default 0).

startDate: Date

Inherited from startDate

Maps to the schema key start_date.

taskId: string

readonly
dag.ts:134

Airflow task ID, when it should not be the handler's function name.

dag.task(handler) takes the id from the handler's name. Set this for an id that has to outlive that name, or for an anonymous handler, which has no name to take one from.

triggerRule: string

Inherited from triggerRule

Maps to the schema key trigger_rule (schema default "all_success").

waitForDownstream: boolean

Inherited from waitForDownstream

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

waitForPastDependsBeforeSkipping: boolean

Inherited from waitForPastDependsBeforeSkipping

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

weightRule: string

Inherited from weightRule

Maps to the schema key weight_rule (schema default "downstream").