Source code for airflow.providers.google.cloud.links.dataplex

#
# 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.
"""This module contains Google Dataplex links."""

from __future__ import annotations

from typing import TYPE_CHECKING

from airflow.providers.google.cloud.links.base import BaseGoogleLink

if TYPE_CHECKING:
    from airflow.utils.context import Context


[docs]
DATAPLEX_BASE_LINK = "/dataplex/process/tasks"


[docs]
DATAPLEX_TASK_LINK = DATAPLEX_BASE_LINK + "/{lake_id}.{task_id};location={region}/jobs?project={project_id}"


[docs]
DATAPLEX_TASKS_LINK = DATAPLEX_BASE_LINK + "?project={project_id}&qLake={lake_id}.{region}"



[docs]
DATAPLEX_LAKE_LINK = "/dataplex/lakes/{lake_id};location={region}?project={project_id}"


[docs]
DATAPLEX_CATALOG_ENTRY_GROUPS_LINK = "/dataplex/catalog/entry-groups?project={project_id}"


[docs]
DATAPLEX_CATALOG_ENTRY_GROUP_LINK = (
    "/dataplex/projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}?project={project_id}"
)


[docs]
DATAPLEX_CATALOG_ENTRY_TYPE_LINK = (
    "/dataplex/projects/{project_id}/locations/{location}/entryTypes/{entry_type_id}?project={project_id}"
)


[docs]
DATAPLEX_CATALOG_ENTRY_TYPES_LINK = "/dataplex/catalog/entry-types?project={project_id}"


[docs]
DATAPLEX_CATALOG_ASPECT_TYPE_LINK = (
    "/dataplex/projects/{project_id}/locations/{location}/aspectTypes/{aspect_type_id}?project={project_id}"
)


[docs]
DATAPLEX_CATALOG_ASPECT_TYPES_LINK = "/dataplex/catalog/aspect-types?project={project_id}"


[docs]
DATAPLEX_CATALOG_ENTRY_LINK = "/dataplex/dp-entries/projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}?project={project_id}"




[docs]
class DataplexTaskLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Task link."""


[docs]
    name = "Dataplex Task"


[docs]
    key = "task_conf"


[docs]
    format_str = DATAPLEX_TASK_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexTaskLink.key,
            value={
                "lake_id": task_instance.lake_id,
                "task_id": task_instance.dataplex_task_id,
                "region": task_instance.region,
                "project_id": task_instance.project_id,
            },
        )





[docs]
class DataplexTasksLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Tasks link."""


[docs]
    name = "Dataplex Tasks"


[docs]
    key = "tasks_conf"


[docs]
    format_str = DATAPLEX_TASKS_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexTasksLink.key,
            value={
                "project_id": task_instance.project_id,
                "lake_id": task_instance.lake_id,
                "region": task_instance.region,
            },
        )





[docs]
class DataplexLakeLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Lake link."""


[docs]
    name = "Dataplex Lake"


[docs]
    key = "dataplex_lake_key"


[docs]
    format_str = DATAPLEX_LAKE_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexLakeLink.key,
            value={
                "lake_id": task_instance.lake_id,
                "region": task_instance.region,
                "project_id": task_instance.project_id,
            },
        )





[docs]
class DataplexCatalogEntryGroupLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Catalog EntryGroup link."""


[docs]
    name = "Dataplex Catalog EntryGroup"


[docs]
    key = "dataplex_catalog_entry_group_key"


[docs]
    format_str = DATAPLEX_CATALOG_ENTRY_GROUP_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexCatalogEntryGroupLink.key,
            value={
                "entry_group_id": task_instance.entry_group_id,
                "location": task_instance.location,
                "project_id": task_instance.project_id,
            },
        )





[docs]
class DataplexCatalogEntryGroupsLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Catalog EntryGroups link."""


[docs]
    name = "Dataplex Catalog EntryGroups"


[docs]
    key = "dataplex_catalog_entry_groups_key"


[docs]
    format_str = DATAPLEX_CATALOG_ENTRY_GROUPS_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexCatalogEntryGroupsLink.key,
            value={
                "location": task_instance.location,
                "project_id": task_instance.project_id,
            },
        )





[docs]
class DataplexCatalogEntryTypeLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Catalog EntryType link."""


[docs]
    name = "Dataplex Catalog EntryType"


[docs]
    key = "dataplex_catalog_entry_type_key"


[docs]
    format_str = DATAPLEX_CATALOG_ENTRY_TYPE_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexCatalogEntryTypeLink.key,
            value={
                "entry_type_id": task_instance.entry_type_id,
                "location": task_instance.location,
                "project_id": task_instance.project_id,
            },
        )





[docs]
class DataplexCatalogEntryTypesLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Catalog EntryTypes link."""


[docs]
    name = "Dataplex Catalog EntryTypes"


[docs]
    key = "dataplex_catalog_entry_types_key"


[docs]
    format_str = DATAPLEX_CATALOG_ENTRY_TYPES_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexCatalogEntryTypesLink.key,
            value={
                "location": task_instance.location,
                "project_id": task_instance.project_id,
            },
        )





[docs]
class DataplexCatalogAspectTypeLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Catalog AspectType link."""


[docs]
    name = "Dataplex Catalog AspectType"


[docs]
    key = "dataplex_catalog_aspect_type_key"


[docs]
    format_str = DATAPLEX_CATALOG_ASPECT_TYPE_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexCatalogAspectTypeLink.key,
            value={
                "aspect_type_id": task_instance.aspect_type_id,
                "location": task_instance.location,
                "project_id": task_instance.project_id,
            },
        )





[docs]
class DataplexCatalogAspectTypesLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Catalog AspectTypes link."""


[docs]
    name = "Dataplex Catalog AspectTypes"


[docs]
    key = "dataplex_catalog_aspect_types_key"


[docs]
    format_str = DATAPLEX_CATALOG_ASPECT_TYPES_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexCatalogAspectTypesLink.key,
            value={
                "location": task_instance.location,
                "project_id": task_instance.project_id,
            },
        )





[docs]
class DataplexCatalogEntryLink(BaseGoogleLink):
    """Helper class for constructing Dataplex Catalog Entry link."""


[docs]
    name = "Dataplex Catalog Entry"


[docs]
    key = "dataplex_catalog_entry_key"


[docs]
    format_str = DATAPLEX_CATALOG_ENTRY_LINK


    @staticmethod

[docs]
    def persist(
        context: Context,
        task_instance,
    ):
        task_instance.xcom_push(
            context=context,
            key=DataplexCatalogEntryLink.key,
            value={
                "entry_id": task_instance.entry_id,
                "entry_group_id": task_instance.entry_group_id,
                "location": task_instance.location,
                "project_id": task_instance.project_id,
            },
        )