airflow.providers.airbyte.sensors.airbyte¶

This module contains a Airbyte Job sensor.

Classes¶

AirbyteJobSensor

Check for the state of a previously submitted Airbyte job.

Module Contents¶

class airflow.providers.airbyte.sensors.airbyte.AirbyteJobSensor(*, airbyte_job_id, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), airbyte_conn_id='airbyte_default', api_version='v1', **kwargs)[source]¶

Bases: airflow.sensors.base.BaseSensorOperator

Check for the state of a previously submitted Airbyte job.

Parameters:

airbyte_job_id (int) – Required. Id of the Airbyte job.
airbyte_conn_id (str) – Optional. The name of the Airflow connection to get connection information for Airbyte. Defaults to “airbyte_default”.
deferrable (bool) – Optional. Runs the sensor in deferrable mode. Defaults to the config value “default_deferrable” or False, if not defined.
api_version (str) – Optional. Airbyte API version. Defaults to “v1”.

template_fields: collections.abc.Sequence[str] = ('airbyte_job_id',)[source]¶

ui_color = '#6C51FD'[source]¶

deferrable = True[source]¶

airbyte_conn_id = 'airbyte_default'[source]¶

airbyte_job_id[source]¶

api_version = 'v1'[source]¶

poke(context)[source]¶

Override when deriving this class.

execute(context)[source]¶

Submit a job which generates a run_id and gets deferred.

execute_complete(context, event=None)[source]¶

Invoke this callback when the trigger fires; return immediately.

Relies on trigger to throw an exception, otherwise it assumes execution was successful.