• Home
• airflow.providers.sftp
• airflow.providers.sftp.sensors
• airflow.providers.sftp.sensors.sftp

airflow.providers.sftp.sensors.sftp

This module contains SFTP sensor.

Classes

SFTPSensor

Waits for a file or directory to be present on SFTP.

Module Contents

class airflow.providers.sftp.sensors.sftp.SFTPSensor(*, path, file_pattern='', newer_than=None, sftp_conn_id='sftp_default', python_callable=None, op_args=None, op_kwargs=None, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)

Bases: airflow.providers.sftp.version_compat.BaseSensorOperator

Waits for a file or directory to be present on SFTP.

Parameters:

• path (str) – Remote file or directory path

• file_pattern (str) – The pattern that will be used to match the file (fnmatch format)

• sftp_conn_id (str) – The connection to run the sensor against

• newer_than (datetime.datetime | str | None) – DateTime for which the file or file path should be newer than, comparison is inclusive

• deferrable (bool) – If waiting for completion, whether to defer the task until done, default is False.

template_fields: collections.abc.Sequence[str] = ('path', 'newer_than')

path

file_pattern = ''

hook: airflow.providers.sftp.hooks.sftp.SFTPHook | None = None

sftp_conn_id = 'sftp_default'

newer_than: datetime.datetime | str | None = None

python_callable: collections.abc.Callable | None = None

op_args = []

op_kwargs

deferrable = True

poke(context)

Override when deriving this class.

execute(context)

Derive when creating an operator.

The main method to execute the task. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

execute_complete(context, event=None)

Execute callback when the trigger fires; returns immediately.

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

Previous Next

Was this entry helpful?