Skip to content

Apache Airflow model

Base class for Apache Airflow assets.

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand developing with Atlan. For that, we would suggest starting with either:

  • Snippets — small, atomic examples of single-step use cases.
  • Patterns — walkthroughs of common multi-step implementation patterns.
classDiagram
    direction RL
    class Airflow {
        <<abstract>>
    }
    link Airflow "../airflow"
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Catalog <|-- Airflow : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Catalog : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class AirflowDag
    link AirflowDag "../entities/airflowdag"
    Airflow <|-- AirflowDag : extends
    class AirflowTask
    link AirflowTask "../entities/airflowtask"
    Airflow <|-- AirflowTask : extends

Type-specific properties

Following are the properties that are uniquely available on Airflow assets in Atlan.

airflowRunEndTime
End time of the run.
1
2
3
builder.airflowRunEndTime(123456789L); // (1)
airflow.getAirflowRunEndTime(); // (2)
client.assets.select().where(Airflow.AIRFLOW_RUN_END_TIME.gt(123456789L)); // (3)
  1. Set the airflowRunEndTime for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflowRunEndTime from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflowRunEndTime greater than the provided value.

    For more details

    For more information, see the searching section on range queries.

airflowRunName
Name of the run.
1
2
3
builder.airflowRunName("String0"); // (1)
airflow.getAirflowRunName(); // (2)
client.assets.select().where(Airflow.AIRFLOW_RUN_NAME.eq("String0")); // (3)
  1. Set the airflowRunName for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflowRunName from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflowRunName exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflowRunOpenLineageState
State of the run in OpenLineage.
1
2
3
builder.airflowRunOpenLineageState(OpenLineageRunState.START); // (1)
airflow.getAirflowRunOpenLineageState(); // (2)
client.assets.select().where(Airflow.AIRFLOW_RUN_OPEN_LINEAGE_STATE.eq(OpenLineageRunState.START)); // (3)
  1. Set the airflowRunOpenLineageState for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflowRunOpenLineageState from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflowRunOpenLineageState exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflowRunOpenLineageVersion
Version of the run in OpenLineage.
1
2
3
builder.airflowRunOpenLineageVersion("String0"); // (1)
airflow.getAirflowRunOpenLineageVersion(); // (2)
client.assets.select().where(Airflow.AIRFLOW_RUN_OPEN_LINEAGE_VERSION.eq("String0")); // (3)
  1. Set the airflowRunOpenLineageVersion for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflowRunOpenLineageVersion from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflowRunOpenLineageVersion exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflowRunStartTime
Start time of the run.
1
2
3
builder.airflowRunStartTime(123456789L); // (1)
airflow.getAirflowRunStartTime(); // (2)
client.assets.select().where(Airflow.AIRFLOW_RUN_START_TIME.gt(123456789L)); // (3)
  1. Set the airflowRunStartTime for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflowRunStartTime from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflowRunStartTime greater than the provided value.

    For more details

    For more information, see the searching section on range queries.

airflowRunType
Type of the run.
1
2
3
builder.airflowRunType("String0"); // (1)
airflow.getAirflowRunType(); // (2)
client.assets.select().where(Airflow.AIRFLOW_RUN_TYPE.eq("String0")); // (3)
  1. Set the airflowRunType for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflowRunType from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflowRunType exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflowRunVersion
Version of the run in Airflow.
1
2
3
builder.airflowRunVersion("String0"); // (1)
airflow.getAirflowRunVersion(); // (2)
client.assets.select().where(Airflow.AIRFLOW_RUN_VERSION.eq("String0")); // (3)
  1. Set the airflowRunVersion for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflowRunVersion from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflowRunVersion exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflowTags
Tags assigned to the asset in Airflow.
1
2
3
4
5
builder // (1)
    .airflowTag("String0")
    .airflowTag("String1");
airflow.getAirflowTags(); // (2)
client.assets.select().where(Airflow.AIRFLOW_TAGS.eq("String0")); // (3)
  1. Set the airflowTags for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflowTags from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflowTags exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflow_run_end_time
End time of the run.
1
2
3
builder.airflow_run_end_time = ...  # (1)
airflow.airflow_run_end_time  # (2)
FluentSearch().where(FluentSearch.asset_type(Airflow)).where(Airflow.AIRFLOW_RUN_END_TIME.gt(123))  # (3)
  1. Set the airflow_run_end_time for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflow_run_end_time from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflow_run_end_time greater than the provided value.

    For more details

    For more information, see the searching section on range queries.

airflow_run_name
Name of the run.
1
2
3
builder.airflow_run_name = ...  # (1)
airflow.airflow_run_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Airflow)).where(Airflow.AIRFLOW_RUN_NAME.eq("String0"))  # (3)
  1. Set the airflow_run_name for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflow_run_name from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflow_run_name exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflow_run_open_lineage_state
State of the run in OpenLineage.
1
2
3
builder.airflow_run_open_lineage_state = ...  # (1)
airflow.airflow_run_open_lineage_state  # (2)
FluentSearch().where(FluentSearch.asset_type(Airflow)).where(Airflow.AIRFLOW_RUN_OPEN_LINEAGE_STATE.eq("String0"))  # (3)
  1. Set the airflow_run_open_lineage_state for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflow_run_open_lineage_state from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflow_run_open_lineage_state exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflow_run_open_lineage_version
Version of the run in OpenLineage.
1
2
3
builder.airflow_run_open_lineage_version = ...  # (1)
airflow.airflow_run_open_lineage_version  # (2)
FluentSearch().where(FluentSearch.asset_type(Airflow)).where(Airflow.AIRFLOW_RUN_OPEN_LINEAGE_VERSION.eq("String0"))  # (3)
  1. Set the airflow_run_open_lineage_version for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflow_run_open_lineage_version from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflow_run_open_lineage_version exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflow_run_start_time
Start time of the run.
1
2
3
builder.airflow_run_start_time = ...  # (1)
airflow.airflow_run_start_time  # (2)
FluentSearch().where(FluentSearch.asset_type(Airflow)).where(Airflow.AIRFLOW_RUN_START_TIME.gt(123))  # (3)
  1. Set the airflow_run_start_time for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflow_run_start_time from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflow_run_start_time greater than the provided value.

    For more details

    For more information, see the searching section on range queries.

airflow_run_type
Type of the run.
1
2
3
builder.airflow_run_type = ...  # (1)
airflow.airflow_run_type  # (2)
FluentSearch().where(FluentSearch.asset_type(Airflow)).where(Airflow.AIRFLOW_RUN_TYPE.eq("String0"))  # (3)
  1. Set the airflow_run_type for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflow_run_type from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflow_run_type exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflow_run_version
Version of the run in Airflow.
1
2
3
builder.airflow_run_version = ...  # (1)
airflow.airflow_run_version  # (2)
FluentSearch().where(FluentSearch.asset_type(Airflow)).where(Airflow.AIRFLOW_RUN_VERSION.eq("String0"))  # (3)
  1. Set the airflow_run_version for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflow_run_version from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflow_run_version exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflow_tags
Tags assigned to the asset in Airflow.
1
2
3
builder.airflow_tags = {...}  # (1)
airflow.airflow_tags  # (2)
FluentSearch().where(FluentSearch.asset_type(Airflow)).where(Airflow.AIRFLOW_TAGS.eq("String0"))  # (3)
  1. Set the airflow_tags for a Airflow.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the airflow_tags from a Airflow.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their airflow_tags exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

airflowRunEndTime
End time of the run.
1
2
3
4
5
{
  "attributes": {
    "airflowRunEndTime": 123456789 // (1)
  }
}
  1. Set the airflowRunEndTime for a Airflow.

    For more details

    For more information, see the asset CRUD snippets.

airflowRunName
Name of the run.
1
2
3
4
5
{
  "attributes": {
    "airflowRunName": "String0" // (1)
  }
}
  1. Set the airflowRunName for a Airflow.

    For more details

    For more information, see the asset CRUD snippets.

airflowRunOpenLineageState
State of the run in OpenLineage.
1
2
3
4
5
{
  "attributes": {
    "airflowRunOpenLineageState": "START" // (1)
  }
}
  1. Set the airflowRunOpenLineageState for a Airflow.

    For more details

    For more information, see the asset CRUD snippets.

airflowRunOpenLineageVersion
Version of the run in OpenLineage.
1
2
3
4
5
{
  "attributes": {
    "airflowRunOpenLineageVersion": "String0" // (1)
  }
}
  1. Set the airflowRunOpenLineageVersion for a Airflow.

    For more details

    For more information, see the asset CRUD snippets.

airflowRunStartTime
Start time of the run.
1
2
3
4
5
{
  "attributes": {
    "airflowRunStartTime": 123456789 // (1)
  }
}
  1. Set the airflowRunStartTime for a Airflow.

    For more details

    For more information, see the asset CRUD snippets.

airflowRunType
Type of the run.
1
2
3
4
5
{
  "attributes": {
    "airflowRunType": "String0" // (1)
  }
}
  1. Set the airflowRunType for a Airflow.

    For more details

    For more information, see the asset CRUD snippets.

airflowRunVersion
Version of the run in Airflow.
1
2
3
4
5
{
  "attributes": {
    "airflowRunVersion": "String0" // (1)
  }
}
  1. Set the airflowRunVersion for a Airflow.

    For more details

    For more information, see the asset CRUD snippets.

airflowTags
Tags assigned to the asset in Airflow.
1
2
3
4
5
6
7
8
{
  "attributes": {
    "airflowTags": [ // (1)
      "String0",
      "String1"
    ]
  }
}
  1. Set the airflowTags for a Airflow.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

The following illustrates how the various S3 objects inter-relate with each other:

erDiagram
    Connection ||..o{ AirflowDag : ""
    AirflowDag ||--o{ AirflowTask : airflowTasks