ClearTaskInstances

Properties

NameTypeDescriptionNotes
dag_run_idstr, none_typeThe DagRun ID for this task instance[optional]
dry_runboolIf set, don't actually run this operation. The response will contain a list of task instances planned to be cleaned, but not modified in any way.[optional] if omitted the server will use the default value of True
end_datestrThe maximum execution date to clear.[optional]
include_downstreamboolIf set to true, downstream tasks are also affected.[optional] if omitted the server will use the default value of False
include_futureboolIf set to True, also tasks from future DAG Runs are affected.[optional] if omitted the server will use the default value of False
include_parentdagboolClear tasks in the parent dag of the subdag.[optional]
include_pastboolIf set to True, also tasks from past DAG Runs are affected.[optional] if omitted the server will use the default value of False
include_subdagsboolClear tasks in subdags and clear external tasks indicated by ExternalTaskMarker.[optional]
include_upstreamboolIf set to true, upstream tasks are also affected.[optional] if omitted the server will use the default value of False
only_failedboolOnly clear failed tasks.[optional] if omitted the server will use the default value of True
only_runningboolOnly clear running tasks.[optional] if omitted the server will use the default value of False
reset_dag_runsboolSet state of DAG runs to RUNNING.[optional]
start_datestrThe minimum execution date to clear.[optional]
task_ids[str]A list of task ids to clear. New in version 2.1.0[optional]
any string namebool, date, datetime, dict, float, int, list, str, none_typeany string name can be used but the value must be the correct type[optional]

[Back to Model list] [Back to API list] [Back to README]