airflow.sensors.filesystem

Module Contents

Classes

FileSensor

Waits for a file or folder to land in a filesystem.
class airflow.sensors.filesystem.FileSensor(*, filepath, fs_conn_id='fs_default', recursive=False, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Waits for a file or folder to land in a filesystem.

If the path given is a directory then this sensor will only return true if any files exist inside it (either directly, or within a subdirectory)

Parameters

  • fs_conn_id -- reference to the File (path) connection id

  • filepath -- File or folder name (relative to the base path set within the connection), can be a glob.

  • recursive -- when set to True, enables recursive directory matching behavior of ** in glob filepath parameter. Defaults to False.

See also

For more information on how to use this sensor, take a look at the guide: FileSensor

template_fields: Sequence[str] = ('filepath',)[source]
ui_color = '#91818a'[source]
poke(context)[source]

Function defined by the sensors while deriving this class should override.

Was this entry helpful?