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 = (
    "https://console.cloud.google.com/dataplex/lakes/{lake_id};location={region}?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,
            },
        )