config

fun config(key: String, value: Any?): TriggerDagRun

Sets one TriggerDagRunOperator setting, named as Python names the parameter.

KeyValue
trigger_run_idString; generated when unset, and for a run with no logical date from run_after plus a random eight-character suffix
confMap with string keys and JSON values
logical_dateOffsetDateTime or Instant; the trigger time when neither this nor run_after is set, and none when only run_after is
run_afterOffsetDateTime or Instant
reset_dag_runBoolean: clear a run with the same ID instead of failing
wait_for_completionBoolean: hold this task open until the run finishes
poke_intervalDuration, whole seconds; 60 seconds when unset
allowed_statesstates that count as success; success when unset
failed_statesstates that count as failure; failed when unset
skip_when_already_existsBoolean: skip rather than fail when the run exists
fail_when_dag_is_pausedBoolean: fail rather than trigger a paused Dag
noteString recorded against the triggered run
deferrableBoolean: while waiting, defer instead of holding the worker

A deferrable left unset follows Airflow's [operators] default_deferrable.

Return

This task, for chaining.

Parameters

key

One of the keys above.

value

Value of the shape that key takes.

Throws

if the key is unknown or the value does not match it.