MrGeorgeOwl commented on code in PR #27833: URL: https://github.com/apache/airflow/pull/27833#discussion_r1039382739
########## airflow/providers/google/cloud/triggers/bigquery_dts.py: ########## @@ -0,0 +1,156 @@ +# 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 +from typing import Any, AsyncIterator, Sequence + +from google.cloud.bigquery_datatransfer_v1 import TransferRun, TransferState + +from airflow.providers.google.cloud.hooks.bigquery_dts import AsyncBiqQueryDataTransferServiceHook +from airflow.triggers.base import BaseTrigger, TriggerEvent + + +class BigQueryDataTransferRunTrigger(BaseTrigger): + """Triggers class to watch the Transfer Run state to define when the job is done. + :param project_id: The BigQuery project id where the transfer configuration should be + :param config_id: ID of the config of the Transfer Run which should be watched. + :param run_id: ID of the Transfer Run which should be watched. + :param poll_interval: Optional. Interval which defines how often triggers check status of the job. + :param gcp_conn_id: The connection ID used to connect to Google Cloud. + :param delegate_to: The account to impersonate using domain-wide delegation of authority, + if any. For this to work, the service account making the request must have + domain-wide delegation enabled. + :param location: BigQuery Transfer Service location for regional transfers. + :param impersonation_chain: Optional service account to impersonate using short-term + credentials, or chained list of accounts required to get the access_token + of the last account in the list, which will be impersonated in the request. + If set as a string, the account must grant the originating account + the Service Account Token Creator IAM role. + If set as a sequence, the identities from the list must grant + Service Account Token Creator IAM role to the directly preceding identity, with first + account from the list granting this role to the originating account (templated). + """ + + def __init__( + self, + project_id: str, + config_id: str, + run_id: str, + poll_interval: int = 10, + gcp_conn_id: str = "google_cloud_default", + delegate_to: str | None = None, + location: str | None = None, + impersonation_chain: str | Sequence[str] | None = None, + ): + super().__init__() + self.project_id = project_id + self.config_id = config_id + self.run_id = run_id + self.poll_interval = poll_interval + self.gcp_conn_id = gcp_conn_id + self.delegate_to = delegate_to + self.location = location + self.impersonation_chain = impersonation_chain + + def serialize(self) -> tuple[str, dict[str, Any]]: + """Serializes class arguments and classpath.""" + return ( + "airflow.providers.google.cloud.triggers.bigquery_dts.BigQueryDataTransferRunTrigger", + { + "project_id": self.project_id, + "config_id": self.config_id, + "run_id": self.run_id, + "poll_interval": self.poll_interval, + "gcp_conn_id": self.gcp_conn_id, + "delegate_to": self.delegate_to, + "location": self.location, + "impersonation_chain": self.impersonation_chain, + }, + ) + + async def run(self) -> AsyncIterator[TriggerEvent]: + """ + Get Transfer Run status and if it one of the statuses which mean end of the job + then yield TriggerEvent object. + """ + hook = self._get_async_hook() + while True: + try: + transfer_run: TransferRun = await hook.get_transfer_run( + project_id=self.project_id, + config_id=self.config_id, + run_id=self.run_id, + ) + state = transfer_run.state + self.log.info("Current state is %s", state) + + if state == TransferState.SUCCEEDED: + self.log.info("Job has completed it's work.") + yield TriggerEvent( + { + "status": "success", + "run_id": self.run_id, + "message": "Job completed", + } + ) + return Review Comment: Please check message above -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
