sdk/org.apache.airflow.sdk/Client

Client

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

An instance is provided when a task is being executed. All reads and writes are automatically scoped to the current Dag run and task instance unless you pass explicit IDs.

Properties

taskStateStore

val taskStateStore: TaskStateStore

Key-value state scoped to the current task instance.

Functions

deleteVariable

fun deleteVariable(key: String)

Deletes an Airflow variable.

getConnection

fun getConnection(id: String): Connection

Retrieves a connection from the Airflow connection store.

getVariable

fun getVariable(key: String): Any?

Retrieves an Airflow variable.

getXCom

@JvmOverloads

fun getXCom(key: String = XCOM_RETURN_KEY, dagId: String = details.ti.dagId, taskId: String, runId: String = details.ti.runId, mapIndex: Int? = null, includePriorDates: Boolean = false): Any?

Reads an XCom value pushed by another task.

setVariable

@JvmOverloads

fun setVariable(key: String, value: String, description: String? = null)

Stores an Airflow variable, replacing any existing value.

setXCom

@JvmOverloads

fun setXCom(key: String = XCOM_RETURN_KEY, value: Any)

Pushes an XCom value for downstream tasks to read.