airflow.providers.microsoft.azure.sensors.msgraph¶
類¶
一個 Microsoft Graph API 感測器，它允許您輪詢對 Microsoft Graph API 的非同步 REST 呼叫。 |
模組內容¶
- class airflow.providers.microsoft.azure.sensors.msgraph.MSGraphSensor(url, response_type=None, path_parameters=None, url_template=None, method='GET', query_parameters=None, headers=None, data=None, conn_id=KiotaRequestAdapterHook.default_conn_name, proxies=None, scopes=None, api_version=None, event_processor=lambda e, **context: ..., result_processor=lambda result, **context: ..., serializer=ResponseSerializer, retry_delay=60, **kwargs)[source]¶
基類：
airflow.sensors.base.BaseSensorOperator一個 Microsoft Graph API 感測器，它允許您輪詢對 Microsoft Graph API 的非同步 REST 呼叫。
- 引數：
url (str) – 在 Microsoft Graph API 上執行的 URL（模板化）。
response_type (str | None) – 響應的預期返回型別（字串形式）。可能的值有：bytes、str、int、float、bool 和 datetime（預設為 None）。
method (str) – 用於進行 REST 呼叫的 HTTP 方法（預設為 GET）。
conn_id (str) – 用於執行此運算子的 HTTP 連線 ID（模板化）。
proxies (dict | None) – 定義要使用的 HTTP 代理的字典（預設為 None）。
scopes (str | list[str] | None) – 要使用的範圍（預設為 [”https://graph.microsoft.com/.default”]）。
api_version (msgraph_core.APIVersion | str | None) – 要使用的 Microsoft Graph API 版本（預設為 v1）。您可以傳遞一個名為 APIVersion 的列舉，它有兩個可能的成員：v1 和 beta，或者您可以傳遞字串，如 v1.0 或 beta。
event_processor (Callable[[Any, airflow.utils.context.Context], bool]) – 檢查 MS Graph API 響應並返回布林值的函式（預設為 default_event_processor 方法）。當結果為 True 時，感測器將停止輪詢，否則將繼續輪詢直到結果為 True 或超時。
result_processor (Callable[[Any, airflow.utils.context.Context], Any]) – 進一步處理 MS Graph API 響應的函式（預設為 lambda: response, context: response）。當 KiotaRequestAdapterHook 返回的響應是 bytes 時，它們將被 base64 編碼為字串。
serializer (type[airflow.providers.microsoft.azure.triggers.msgraph.ResponseSerializer]) – 處理響應序列化的類（預設為 ResponseSerializer）。Bytes 將被 base64 編碼為字串，以便可以作為 XCom 儲存。
- template_fields: collections.abc.Sequence[str] = ('url', 'response_type', 'path_parameters', 'url_template', 'query_parameters', 'headers',...[source]¶