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

# 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.

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]BASE_LINK = "https://console.cloud.google.com"

[docs]DLP_BASE_LINK = BASE_LINK + "/security/dlp"

[docs]DLP_DEIDENTIFY_TEMPLATES_LIST_LINK = (
    DLP_BASE_LINK + "/landing/configuration/templates/deidentify?project={project_id}"
)
[docs]DLP_DEIDENTIFY_TEMPLATE_DETAILS_LINK = (
    DLP_BASE_LINK
    + "/projects/{project_id}/locations/global/deidentifyTemplates/{template_name}?project={project_id}"
)

[docs]DLP_JOB_TRIGGER_LIST_LINK = DLP_BASE_LINK + "/landing/inspection/triggers?project={project_id}"
[docs]DLP_JOB_TRIGGER_DETAILS_LINK = (
    DLP_BASE_LINK + "/projects/{project_id}/locations/global/jobTriggers/{trigger_name}?project={project_id}"
)

[docs]DLP_JOBS_LIST_LINK = DLP_BASE_LINK + "/landing/inspection/jobs?project={project_id}"
[docs]DLP_JOB_DETAILS_LINK = (
    DLP_BASE_LINK + "/projects/{project_id}/locations/global/dlpJobs/{job_name}?project={project_id}"
)

[docs]DLP_INSPECT_TEMPLATES_LIST_LINK = (
    DLP_BASE_LINK + "/landing/configuration/templates/inspect?project={project_id}"
)
[docs]DLP_INSPECT_TEMPLATE_DETAILS_LINK = (
    DLP_BASE_LINK
    + "/projects/{project_id}/locations/global/inspectTemplates/{template_name}?project={project_id}"
)

[docs]DLP_INFO_TYPES_LIST_LINK = (
    DLP_BASE_LINK + "/landing/configuration/infoTypes/stored?cloudshell=false&project={project_id}"
)
[docs]DLP_INFO_TYPE_DETAILS_LINK = (
    DLP_BASE_LINK
    + "/projects/{project_id}/locations/global/storedInfoTypes/{info_type_name}?project={project_id}"
)
[docs]DLP_POSSIBLE_INFO_TYPES_LIST_LINK = (
    DLP_BASE_LINK + "/landing/configuration/infoTypes/built-in?project={project_id}"
)


[docs]class CloudDLPDeidentifyTemplatesListLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Deidentify Templates List"
[docs]    key = "cloud_dlp_deidentify_templates_list_key"
[docs]    format_str = DLP_DEIDENTIFY_TEMPLATES_LIST_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPDeidentifyTemplatesListLink.key,
            value={
                "project_id": project_id,
            },
        )


[docs]class CloudDLPDeidentifyTemplateDetailsLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Deidentify Template Details"
[docs]    key = "cloud_dlp_deidentify_template_details_key"
[docs]    format_str = DLP_DEIDENTIFY_TEMPLATE_DETAILS_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
        template_name: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPDeidentifyTemplateDetailsLink.key,
            value={
                "project_id": project_id,
                "template_name": template_name,
            },
        )


[docs]class CloudDLPJobTriggersListLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Job Triggers List"
[docs]    key = "cloud_dlp_job_triggers_list_key"
[docs]    format_str = DLP_JOB_TRIGGER_LIST_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPJobTriggersListLink.key,
            value={
                "project_id": project_id,
            },
        )


[docs]class CloudDLPJobTriggerDetailsLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Job Triggers Details"
[docs]    key = "cloud_dlp_job_trigger_details_key"
[docs]    format_str = DLP_JOB_TRIGGER_DETAILS_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
        trigger_name: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPJobTriggerDetailsLink.key,
            value={
                "project_id": project_id,
                "trigger_name": trigger_name,
            },
        )


[docs]class CloudDLPJobsListLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Jobs List"
[docs]    key = "cloud_dlp_jobs_list_key"
[docs]    format_str = DLP_JOBS_LIST_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPJobsListLink.key,
            value={
                "project_id": project_id,
            },
        )


[docs]class CloudDLPJobDetailsLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Job Details"
[docs]    key = "cloud_dlp_job_details_key"
[docs]    format_str = DLP_JOB_DETAILS_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
        job_name: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPJobDetailsLink.key,
            value={
                "project_id": project_id,
                "job_name": job_name,
            },
        )


[docs]class CloudDLPInspectTemplatesListLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Inspect Templates List"
[docs]    key = "cloud_dlp_inspect_templates_list_key"
[docs]    format_str = DLP_INSPECT_TEMPLATES_LIST_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPInspectTemplatesListLink.key,
            value={
                "project_id": project_id,
            },
        )


[docs]class CloudDLPInspectTemplateDetailsLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Inspect Template Details"
[docs]    key = "cloud_dlp_inspect_template_details_key"
[docs]    format_str = DLP_INSPECT_TEMPLATE_DETAILS_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
        template_name: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPInspectTemplateDetailsLink.key,
            value={
                "project_id": project_id,
                "template_name": template_name,
            },
        )


[docs]class CloudDLPInfoTypesListLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Info Types List"
[docs]    key = "cloud_dlp_info_types_list_key"
[docs]    format_str = DLP_INFO_TYPES_LIST_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPInfoTypesListLink.key,
            value={
                "project_id": project_id,
            },
        )


[docs]class CloudDLPInfoTypeDetailsLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Info Type Details"
[docs]    key = "cloud_dlp_info_type_details_key"
[docs]    format_str = DLP_INFO_TYPE_DETAILS_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
        info_type_name: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPInfoTypeDetailsLink.key,
            value={
                "project_id": project_id,
                "info_type_name": info_type_name,
            },
        )


[docs]class CloudDLPPossibleInfoTypesListLink(BaseGoogleLink):
    """Helper class for constructing Cloud Data Loss Prevention link."""

[docs]    name = "Cloud DLP Possible Info Types List"
[docs]    key = "cloud_dlp_possible_info_types_list_key"
[docs]    format_str = DLP_POSSIBLE_INFO_TYPES_LIST_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudDLPPossibleInfoTypesListLink.key,
            value={
                "project_id": project_id,
            },
        )