blob: a1c931597fe8d517fceaae15aac7fdcd3b3734c1 [file] [log] [blame]
:py:mod:`airflow.providers.airbyte.sensors.airbyte`
===================================================
.. py:module:: airflow.providers.airbyte.sensors.airbyte
.. autoapi-nested-parse::
This module contains a Airbyte Job sensor.
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.providers.airbyte.sensors.airbyte.AirbyteJobSensor
.. py:class:: AirbyteJobSensor(*, airbyte_job_id, airbyte_conn_id = 'airbyte_default', api_version = 'v1', **kwargs)
Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator`
Check for the state of a previously submitted Airbyte job.
:param airbyte_job_id: Required. Id of the Airbyte job
:param airbyte_conn_id: Required. The name of the Airflow connection to get
connection information for Airbyte.
:param api_version: Optional. Airbyte API version.
.. py:attribute:: template_fields
:annotation: :Sequence[str] = ['airbyte_job_id']
.. py:attribute:: ui_color
:annotation: = #6C51FD
.. py:method:: poke(self, context)
Function that the sensors defined while deriving this class should
override.