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

# 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]BIGTABLE_BASE_LINK = "/bigtable"
[docs]BIGTABLE_INSTANCE_LINK = BIGTABLE_BASE_LINK + "/instances/{instance_id}/overview?project={project_id}"
[docs]BIGTABLE_CLUSTER_LINK = (
    BIGTABLE_BASE_LINK + "/instances/{instance_id}/clusters/{cluster_id}?project={project_id}"
)
[docs]BIGTABLE_TABLES_LINK = BIGTABLE_BASE_LINK + "/instances/{instance_id}/tables?project={project_id}"


[docs]class BigtableInstanceLink(BaseGoogleLink):
    """Helper class for constructing Bigtable Instance link"""

[docs]    name = "Bigtable Instance"
[docs]    key = "instance_key"
[docs]    format_str = BIGTABLE_INSTANCE_LINK

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


[docs]class BigtableClusterLink(BaseGoogleLink):
    """Helper class for constructing Bigtable Cluster link"""

[docs]    name = "Bigtable Cluster"
[docs]    key = "cluster_key"
[docs]    format_str = BIGTABLE_CLUSTER_LINK

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


[docs]class BigtableTablesLink(BaseGoogleLink):
    """Helper class for constructing Bigtable Tables link"""

[docs]    name = "Bigtable Tables"
[docs]    key = "tables_key"
[docs]    format_str = BIGTABLE_TABLES_LINK

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