Google Git
Sign in
apache/airflow-client-python/refs/heads/release-2.9.1/./docs/DAGDetail.md
blob: b5d9e800c4e4468ddfd7453197ee15aacbc6a346 [file] [view]
# DAGDetail
DAG details. For details see: [airflow.models.dag.DAG](https://airflow.apache.org/docs/apache-airflow/stable/_api/airflow/models/dag/index.html#airflow.models.dag.DAG)
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dag_display_name** | **str** | Human centric display text for the DAG. *New in version 2.9.0* | [optional] [readonly]
**dag_id** | **str** | The ID of the DAG. | [optional] [readonly]
**default_view** | **str, none_type** | | [optional] [readonly]
**description** | **str, none_type** | User-provided DAG description, which can consist of several sentences or paragraphs that describe DAG contents. | [optional] [readonly]
**file_token** | **str** | The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change. | [optional] [readonly]
**fileloc** | **str** | The absolute path to the file. | [optional] [readonly]
**has_import_errors** | **bool, none_type** | Whether the DAG has import errors *New in version 2.3.0* | [optional] [readonly]
**has_task_concurrency_limits** | **bool, none_type** | Whether the DAG has task concurrency limits *New in version 2.3.0* | [optional] [readonly]
**is_active** | **bool, none_type** | Whether the DAG is currently seen by the scheduler(s). *New in version 2.1.1* *Changed in version 2.2.0*: Field is read-only. | [optional] [readonly]
**is_paused** | **bool, none_type** | Whether the DAG is paused. | [optional]
**is_subdag** | **bool** | Whether the DAG is SubDAG. | [optional] [readonly]
**last_expired** | **datetime, none_type** | Time when the DAG last received a refresh signal (e.g. the DAG's \"refresh\" button was clicked in the web UI) *New in version 2.3.0* | [optional] [readonly]
**last_parsed_time** | **datetime, none_type** | The last time the DAG was parsed. *New in version 2.3.0* | [optional] [readonly]
**last_pickled** | **datetime, none_type** | The last time the DAG was pickled. *New in version 2.3.0* | [optional] [readonly]
**max_active_runs** | **int, none_type** | Maximum number of active DAG runs for the DAG *New in version 2.3.0* | [optional] [readonly]
**max_active_tasks** | **int, none_type** | Maximum number of active tasks that can be run on the DAG *New in version 2.3.0* | [optional] [readonly]
**max_consecutive_failed_dag_runs** | **int, none_type** | (experimental) The maximum number of consecutive DAG failures before DAG is automatically paused. *New in version 2.9.0* | [optional] [readonly]
**next_dagrun** | **datetime, none_type** | The logical date of the next dag run. *New in version 2.3.0* | [optional] [readonly]
**next_dagrun_create_after** | **datetime, none_type** | Earliest time at which this ``next_dagrun`` can be created. *New in version 2.3.0* | [optional] [readonly]
**next_dagrun_data_interval_end** | **datetime, none_type** | The end of the interval of the next dag run. *New in version 2.3.0* | [optional] [readonly]
**next_dagrun_data_interval_start** | **datetime, none_type** | The start of the interval of the next dag run. *New in version 2.3.0* | [optional] [readonly]
**owners** | **[str]** | | [optional] [readonly]
**pickle_id** | **str, none_type** | Foreign key to the latest pickle_id *New in version 2.3.0* | [optional] [readonly]
**root_dag_id** | **str, none_type** | If the DAG is SubDAG then it is the top level DAG identifier. Otherwise, null. | [optional] [readonly]
**schedule_interval** | [**ScheduleInterval**](ScheduleInterval.md) | | [optional]
**scheduler_lock** | **bool, none_type** | Whether (one of) the scheduler is scheduling this DAG at the moment *New in version 2.3.0* | [optional] [readonly]
**tags** | [**[Tag], none_type**](Tag.md) | List of tags. | [optional] [readonly]
**timetable_description** | **str, none_type** | Timetable/Schedule Interval description. *New in version 2.3.0* | [optional] [readonly]
**catchup** | **bool, none_type** | | [optional] [readonly]
**concurrency** | **float, none_type** | | [optional] [readonly]
**dag_run_timeout** | [**TimeDelta**](TimeDelta.md) | | [optional]
**dataset_expression** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Nested dataset any/all conditions | [optional]
**doc_md** | **str, none_type** | | [optional] [readonly]
**end_date** | **datetime, none_type** | The DAG's end date. *New in version 2.3.0*. | [optional] [readonly]
**is_paused_upon_creation** | **bool, none_type** | Whether the DAG is paused upon creation. *New in version 2.3.0* | [optional] [readonly]
**last_parsed** | **datetime, none_type** | The last time the DAG was parsed. *New in version 2.3.0* | [optional] [readonly]
**orientation** | **str, none_type** | | [optional] [readonly]
**params** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | User-specified DAG params. *New in version 2.0.1* | [optional] [readonly]
**render_template_as_native_obj** | **bool, none_type** | Whether to render templates as native Python objects. *New in version 2.3.0* | [optional] [readonly]
**start_date** | **datetime, none_type** | The DAG's start date. *Changed in version 2.0.1*: Field becomes nullable. | [optional] [readonly]
**template_search_path** | **[str], none_type** | The template search path. *New in version 2.3.0* | [optional]
**timezone** | **str** | | [optional]
**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)