Source code for airflow.providers.google.cloud.triggers.cloud_composer

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

import asyncio
import logging
from typing import Any, Sequence

from airflow import AirflowException
from airflow.providers.google.cloud.hooks.cloud_composer import CloudComposerAsyncHook

try:
    from airflow.triggers.base import BaseTrigger, TriggerEvent
except ImportError:
    logging.getLogger(__name__).warning(
        'Deferrable Operators only work starting Airflow 2.2',
        exc_info=True,
    )
[docs] BaseTrigger = object # type: ignore
TriggerEvent = None # type: ignore
[docs]class CloudComposerExecutionTrigger(BaseTrigger): """The trigger handles the async communication with the Google Cloud Composer""" def __init__( self, project_id: str, region: str, operation_name: str, gcp_conn_id: str = "google_cloud_default", impersonation_chain: str | Sequence[str] | None = None, delegate_to: str | None = None, pooling_period_seconds: int = 30, ): super().__init__() self.project_id = project_id self.region = region self.operation_name = operation_name self.gcp_conn_id = gcp_conn_id self.impersonation_chain = impersonation_chain self.delegate_to = delegate_to self.pooling_period_seconds = pooling_period_seconds self.gcp_hook = CloudComposerAsyncHook( gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.impersonation_chain, delegate_to=self.delegate_to, )
[docs] def serialize(self) -> tuple[str, dict[str, Any]]: return ( 'airflow.providers.google.cloud.triggers.cloud_composer.CloudComposerExecutionTrigger', { "project_id": self.project_id, "region": self.region, "operation_name": self.operation_name, "gcp_conn_id": self.gcp_conn_id, "impersonation_chain": self.impersonation_chain, "delegate_to": self.delegate_to, "pooling_period_seconds": self.pooling_period_seconds,
}, )
[docs] async def run(self): while True: operation = await self.gcp_hook.get_operation(operation_name=self.operation_name) if operation.done: break elif operation.error.message: raise AirflowException(f"Cloud Composer Environment error: {operation.error.message}") await asyncio.sleep(self.pooling_period_seconds) yield TriggerEvent( { "operation_name": operation.name, "operation_done": operation.done,
} )

Was this entry helpful?