Package-level declarations

Types

Link copied to clipboard
class Airflow

Container for the annotation-based Dag-authoring API.

Link copied to clipboard

Thrown when an Airflow API call returns an error response.

Link copied to clipboard
sealed class Arg<T>

A value a task can be given: the output of an upstream task, carried by the TaskRef that task's registration returned, or an inline constant.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class ArgName(val value: String)

Pins the stub argument a TaskInput field binds, for a Python name that no Java identifier reaches on its own.

Link copied to clipboard
class Bundle(dags: Iterable<DagDef>)

All DagDefs that this JVM process can execute.

Link copied to clipboard
interface BundleBuilder

Entry point for declaring the DagDefs that this bundle contains.

Link copied to clipboard

Build-time introspection entry point for Dag bundles.

Link copied to clipboard
class Client

Client for Airflow API calls scoped to the current task instance.

Link copied to clipboard

A condition registered with a Dag: name the task each outcome runs.

Link copied to clipboard
interface ConditionTask : Task

A task whose boolean decides which of two tasks runs; the other is skipped.

Link copied to clipboard
data class Connection(val id: String, val type: String?, val host: String?, val schema: String?, val login: String?, val password: String?, val port: Int?, val extra: Any?)

A connection registered in Airflow's connection store.

Link copied to clipboard
data class Context(val dagRun: DagRun, val ti: TaskInstance)

Runtime context passed to the task execution.

Link copied to clipboard
class CoordinatorServer(comm: InetSocketAddress, logs: InetSocketAddress) : Server

Serves task-execution requests over the coordinator's comm and logs sockets.

Link copied to clipboard
class DagDef(val id: String)

A collection of tasks with directional dependencies.

Link copied to clipboard
data class DagRun(val dagId: String, val runId: String, val logicalDate: OffsetDateTime?, val dataIntervalStart: OffsetDateTime?, val dataIntervalEnd: OffsetDateTime?, val runAfter: OffsetDateTime?, val runType: DagRunType?, val conf: Map<String, Any?>)

Identifies the Dag run that the current task instance belongs to.

Link copied to clipboard
Link copied to clipboard
interface Deps

Vocabulary for declaring a Dag's task graph in Java, and the base of every generated <Dag>Deps wiring view.

Link copied to clipboard
sealed interface Endpoint

One end of an ordering edge: a single task, or a whole task group.

Link copied to clipboard
interface InputTask<I : TaskInput> : Task

A Task whose input the SDK resolves from the @task.stub TaskFlow call site in the Python Dag file and injects.

Link copied to clipboard
class Label

The text of an edge label. The Airflow UI shows the label on the edge in the graph, as it does for Python's Label. The text comes before the task that the label is put on. That way the text sits between the two tasks of the edge in the code, just as the label sits between them in the graph:

Link copied to clipboard

Thrown when a task's input resolves to nothing where a value is required — a data parameter or a TaskInput field with a primitive type.

Link copied to clipboard
sealed class Server

Connects this JVM process to the Airflow coordinator and dispatches task execution requests to the registered Bundle.

Link copied to clipboard

A switch registered with a Dag: list the tasks it can choose between.

Link copied to clipboard
interface SwitchTask : Task

A task that chooses one of several tasks to run; every other one is skipped.

Link copied to clipboard
interface Task

A single unit of work executed by Airflow.

Link copied to clipboard
class TaskDef(val id: String, val definition: Class<out Task>) : Endpoint

One task definition: its ID, the class that implements it, its upstream dependencies, and its task-level configuration.

Link copied to clipboard

A group of tasks in a Dag, shown in the Airflow UI as one node that expands: Python's TaskGroup.

Link copied to clipboard
interface TaskInput

Marks a class as a task's input: when the Python Dag file calls the stub task with keyword arguments, each public field receives the argument whose name matches it, ignoring case and underscores. That is the same fold the Go and TypeScript SDKs apply, so one Python signature binds identically in every SDK with nothing declared; ArgName pins a name the fold cannot reach.

Link copied to clipboard
data class TaskInstance(val dagId: String, val runId: String, val taskId: String, val mapIndex: Int?, val tryNumber: Int)

Identifies the task instance that is currently executing.

Link copied to clipboard
class TaskRef<T> : Arg<T> , Deps.Flow

The output of a registered task, and the task's place in the flow.

Link copied to clipboard

Key-value state scoped to one task instance, shared across its retries within the same Dag run.

Link copied to clipboard
class TriggerDagRun(val dagId: String)

A task that starts a run of another Dag, in place of a task class.