getXCom

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.

The current Dag run's dagId and runId are used by default; override them only when reading across Dags or runs.

Return

The XCom value, or null if none was pushed.

Parameters

key

XCom key to read; defaults to XCOM_RETURN_KEY.

dagId

Dag that owns the XCom; defaults to the current Dag.

taskId

Task that pushed the XCom.

runId

Run that produced the XCom; defaults to the current run.

mapIndex

Map index of the source task instance.

includePriorDates

If true, also search earlier Dag-run dates.

Throws

if the API call fails.

If map_index is set to null against a mapped task, the task's "collective result" is returned. Results from all mapped instances are aggregated into a list, ordered by the map index (ascending). For a non-mapped task, setting map_index to null is equivalent to -1.