blob: 2a594d7283473f47cd469de50d3890f36a5726f8 [file] [log] [blame] [view]
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# ClearTaskInstances
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dry_run** | **bool** | If set, don&#39;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
**task_ids** | **[str]** | A list of task ids to clear. *New in version 2.1.0* | [optional]
**start_date** | **str** | The minimum execution date to clear. | [optional]
**end_date** | **str** | The maximum execution date to clear. | [optional]
**only_failed** | **bool** | Only clear failed tasks. | [optional] if omitted the server will use the default value of True
**only_running** | **bool** | Only clear running tasks. | [optional] if omitted the server will use the default value of False
**include_subdags** | **bool** | Clear tasks in subdags and clear external tasks indicated by ExternalTaskMarker. | [optional]
**include_parentdag** | **bool** | Clear tasks in the parent dag of the subdag. | [optional]
**reset_dag_runs** | **bool** | Set state of DAG runs to RUNNING. | [optional]
**dag_run_id** | **str, none_type** | The DagRun ID for this task instance | [optional]
**include_upstream** | **bool** | If set to true, upstream tasks are also affected. | [optional] if omitted the server will use the default value of False
**include_downstream** | **bool** | If set to true, downstream tasks are also affected. | [optional] if omitted the server will use the default value of False
**include_future** | **bool** | If set to True, also tasks from future DAG Runs are affected. | [optional] if omitted the server will use the default value of False
**include_past** | **bool** | If set to True, also tasks from past DAG Runs are affected. | [optional] if omitted the server will use the default value of False
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)