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

# 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]
MANAGED_KAFKA_BASE_LINK = "/managedkafka"


[docs]
MANAGED_KAFKA_CLUSTER_LINK = (
    MANAGED_KAFKA_BASE_LINK + "/{location}/clusters/{cluster_id}?project={project_id}"
)


[docs]
MANAGED_KAFKA_CLUSTER_LIST_LINK = MANAGED_KAFKA_BASE_LINK + "/clusters?project={project_id}"


[docs]
MANAGED_KAFKA_TOPIC_LINK = (
    MANAGED_KAFKA_BASE_LINK + "/{location}/clusters/{cluster_id}/topics/{topic_id}?project={project_id}"
)


[docs]
MANAGED_KAFKA_CONSUMER_GROUP_LINK = (
    MANAGED_KAFKA_BASE_LINK
    + "/{location}/clusters/{cluster_id}/consumer_groups/{consumer_group_id}?project={project_id}"
)




[docs]
class ApacheKafkaClusterLink(BaseGoogleLink):
    """Helper class for constructing Apache Kafka Cluster link."""


[docs]
    name = "Apache Kafka Cluster"


[docs]
    key = "cluster_conf"


[docs]
    format_str = MANAGED_KAFKA_CLUSTER_LINK


    @staticmethod

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





[docs]
class ApacheKafkaClusterListLink(BaseGoogleLink):
    """Helper class for constructing Apache Kafka Clusters link."""


[docs]
    name = "Apache Kafka Cluster List"


[docs]
    key = "cluster_list_conf"


[docs]
    format_str = MANAGED_KAFKA_CLUSTER_LIST_LINK


    @staticmethod

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





[docs]
class ApacheKafkaTopicLink(BaseGoogleLink):
    """Helper class for constructing Apache Kafka Topic link."""


[docs]
    name = "Apache Kafka Topic"


[docs]
    key = "topic_conf"


[docs]
    format_str = MANAGED_KAFKA_TOPIC_LINK


    @staticmethod

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





[docs]
class ApacheKafkaConsumerGroupLink(BaseGoogleLink):
    """Helper class for constructing Apache Kafka Consumer Group link."""


[docs]
    name = "Apache Kafka Consumer Group"


[docs]
    key = "consumer_group_conf"


[docs]
    format_str = MANAGED_KAFKA_CONSUMER_GROUP_LINK


    @staticmethod

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