airflow.providers.airbyte.sensors.airbyte

This module contains a Airbyte Job sensor.

Module Contents

Classes

AirbyteJobSensor

Check for the state of a previously submitted Airbyte job.
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', api_type='config', **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

  • deferrable (bool) – Run sensor in the deferrable mode. connection information for Airbyte. Defaults to “airbyte_default”.

  • api_version (str) – Optional. Airbyte API version. Defaults to “v1”.

  • api_type (Literal[config, cloud]) – Optional. The type of Airbyte API to use. Either “config” or “cloud”. Defaults to “config”.

template_fields: Sequence[str] = ('airbyte_job_id',)[source]
ui_color = '#6C51FD'[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.

Was this entry helpful?