Source code for airflow.providers.airbyte.sensors.airbyte

# 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
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
"""This module contains a Airbyte Job sensor."""
from typing import Optional

from airflow.exceptions import AirflowException
from airflow.providers.airbyte.hooks.airbyte import AirbyteHook
from airflow.sensors.base import BaseSensorOperator

[docs]class AirbyteJobSensor(BaseSensorOperator): """ Check for the state of a previously submitted Airbyte job. :param airbyte_job_id: Required. Id of the Airbyte job :type airbyte_job_id: str :param airbyte_conn_id: Required. The name of the Airflow connection to get connection information for Airbyte. :type airbyte_conn_id: str :param api_version: Optional. Airbyte API version. :type api_version: str """
[docs] template_fields = ('airbyte_job_id',)
[docs] ui_color = '#6C51FD'
def __init__( self, *, airbyte_job_id: str, airbyte_conn_id: str = 'airbyte_default', api_version: Optional[str] = "v1", **kwargs, ) -> None: super().__init__(**kwargs) self.airbyte_conn_id = airbyte_conn_id self.airbyte_job_id = airbyte_job_id self.api_version = api_version
[docs] def poke(self, context: dict) -> bool: hook = AirbyteHook(airbyte_conn_id=self.airbyte_conn_id, api_version=self.api_version) job = hook.get_job(job_id=self.airbyte_job_id) status = job.json()['job']['status'] if status == hook.FAILED: raise AirflowException(f"Job failed: \n{job}") elif status == hook.CANCELLED: raise AirflowException(f"Job was cancelled: \n{job}") elif status == hook.SUCCEEDED:"Job %s completed successfully.", self.airbyte_job_id) return True elif status == hook.ERROR:"Job %s attempt has failed.", self.airbyte_job_id)"Waiting for job %s to complete.", self.airbyte_job_id) return False

Was this entry helpful?