Source code for airflow.providers.google.cloud.links.workflows
#
# 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 Workflows links."""
from __future__ import annotations
from typing import TYPE_CHECKING
from airflow.providers.google.cloud.links.base import BaseGoogleLink
if TYPE_CHECKING:
from airflow.models import BaseOperator
from airflow.utils.context import Context
[docs]WORKFLOWS_BASE_LINK = "/workflows"
[docs]WORKFLOW_LINK = WORKFLOWS_BASE_LINK + "/workflow/{location_id}/{workflow_id}/executions?project={project_id}"
[docs]WORKFLOWS_LINK = WORKFLOWS_BASE_LINK + "?project={project_id}"
[docs]EXECUTION_LINK = (
WORKFLOWS_BASE_LINK
+ "/workflow/{location_id}/{workflow_id}/execution/{execution_id}?project={project_id}"
)
[docs]class WorkflowsWorkflowDetailsLink(BaseGoogleLink):
"""Helper class for constructing Workflow details Link."""
[docs] name = "Workflow details"
[docs] key = "workflow_details"
@staticmethod
[docs] def persist(
context: Context,
task_instance: BaseOperator,
location_id: str,
workflow_id: str,
project_id: str | None,
):
task_instance.xcom_push(
context,
key=WorkflowsWorkflowDetailsLink.key,
value={"location_id": location_id, "workflow_id": workflow_id, "project_id": project_id},
)
[docs]class WorkflowsListOfWorkflowsLink(BaseGoogleLink):
"""Helper class for constructing list of Workflows Link."""
[docs] name = "List of workflows"
[docs] key = "list_of_workflows"
@staticmethod
[docs] def persist(
context: Context,
task_instance: BaseOperator,
project_id: str | None,
):
task_instance.xcom_push(
context,
key=WorkflowsListOfWorkflowsLink.key,
value={"project_id": project_id},
)
[docs]class WorkflowsExecutionLink(BaseGoogleLink):
"""Helper class for constructing Workflows Execution Link."""
[docs] name = "Workflow Execution"
[docs] key = "workflow_execution"
@staticmethod
[docs] def persist(
context: Context,
task_instance: BaseOperator,
location_id: str,
workflow_id: str,
execution_id: str,
project_id: str | None,
):
task_instance.xcom_push(
context,
key=WorkflowsExecutionLink.key,
value={
"location_id": location_id,
"workflow_id": workflow_id,
"execution_id": execution_id,
"project_id": project_id,
},
)