airflow.providers.standard.sensors.filesystem

StartTriggerArgs

從觸發器啟動任務執行所需的引數。

FileSensor

等待檔案或資料夾到達檔案系統。

模組內容

class airflow.providers.standard.sensors.filesystem.StartTriggerArgs[source]

從觸發器啟動任務執行所需的引數。

trigger_cls: str[source]
next_method: str[source]
trigger_kwargs: dict[str, Any] | None = None[source]
next_kwargs: dict[str, Any] | None = None[source]
timeout: datetime.timedelta | None = None[source]
class airflow.providers.standard.sensors.filesystem.FileSensor(*, filepath, fs_conn_id='fs_default', recursive=False, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), start_from_trigger=False, trigger_kwargs=None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

等待檔案或資料夾到達檔案系統。

如果給定的路徑是目錄,則此 sensor 僅當目錄記憶體在任何檔案(直接或子目錄內)時返回 true。

引數:
  • fs_conn_id – 檔案(路徑)連線 ID 的引用

  • filepath – 檔案或資料夾名稱(相對於連線中設定的基礎路徑),可以是 glob 表示式。

  • recursive – 設定為 True 時,啟用 glob filepath 引數中 ** 的遞迴目錄匹配行為。預設為 False

  • deferrable (bool) – 如果等待完成,是否將任務延遲執行直到完成,預設為 False

  • start_from_trigger (bool) – 直接從觸發器啟動任務,無需進入 worker。

  • trigger_kwargs (dict[str, Any] | None) – 在動態任務對映期間,當 start_from_trigger 設定為 True 時傳遞給觸發器的關鍵字引數。此引數在標準用法中未使用。

另請參閱

有關如何使用此 sensor 的更多資訊,請參閱指南: FileSensor

template_fields: collections.abc.Sequence[str] = ('filepath',)[source]
ui_color = '#91818a'[source]
start_trigger_args[source]
start_from_trigger = False[source]
filepath[source]
fs_conn_id = 'fs_default'[source]
recursive = False[source]
deferrable = True[source]
property path: str[source]
poke(context)[source]

派生此類時重寫此方法。

execute(context)[source]

建立 operator 時派生此方法。

執行任務的主要方法。context 與渲染 jinja 模板時使用的字典相同。

有關更多 context,請參閱 get_template_context。

execute_complete(context, event=None)[source]

此條目有幫助嗎?