:py:mod:`astronomer.providers.sftp.sensors.sftp`
================================================

.. py:module:: astronomer.providers.sftp.sensors.sftp


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   astronomer.providers.sftp.sensors.sftp.SFTPSensorAsync




.. py:class:: SFTPSensorAsync(*, path, file_pattern = '', timeout = None, **kwargs)

   Bases: :py:obj:`airflow.providers.sftp.sensors.sftp.SFTPSensor`

   Polls an SFTP server continuously until a file_pattern is matched at a defined path

   :param path: The path on the SFTP server to search for a file matching the file pattern.
                Authentication method used in the SFTP connection must have access to this path
   :param file_pattern: Pattern to be used for matching against the list of files at the path above.
                Uses the fnmatch module from std library to perform the matching.
   :param timeout: How long, in seconds, the sensor waits for successful before timing out
   :param newer_than: DateTime for which the file or file path should be newer than, comparison is inclusive

   .. py:method:: execute(context)

      Logic that the sensor uses to correctly identify which trigger to
      execute, and defer execution as expected.


   .. py:method:: execute_complete(context, event = None)

      Callback for when the trigger fires - returns immediately.
      Relies on trigger to throw an exception, otherwise it assumes execution was
      successful.