airflow.providers.microsoft.azure.sensors.msgraph

模組內容

類別

MSGraphSensor

一個 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, api_version=None, event_processor=lambda context, e: ..., result_processor=lambda context, result: ..., serializer=ResponseSerializer, retry_delay=60, **kwargs)[原始碼]

基底: airflow.sensors.base.BaseSensorOperator

一個 Microsoft Graph API 感測器,讓您可以輪詢對 Microsoft Graph API 的非同步 REST 呼叫。

參數
  • url (str) – 在 Microsoft Graph API 上執行的 URL(可使用範本)。

  • response_type (kiota_http.httpx_request_adapter.ResponseType | None) – 預期的回應傳回類型,以字串表示。可能的值為:bytesstrintfloatbooldatetime(預設為 None)。

  • method (str) – 用於執行 REST 呼叫的 HTTP 方法(預設為 GET)。

  • conn_id (str) – 執行運算子的 HTTP 連線 ID(可使用範本)。

  • proxies (dict | None) – 定義要使用的 HTTP Proxy 的字典(預設為 None)。

  • api_version (msgraph_core.APIVersion | str | None) – 要使用的 Microsoft Graph API 的 API 版本(預設為 v1)。您可以傳遞名為 APIVersion 的列舉,其中有 2 個可能的成員 v1 和 beta,或者您可以傳遞字串,如 v1.0beta

  • event_processor (Callable[[airflow.utils.context.Context, Any], bool]) – 檢查來自 MS Graph API 的回應的函數(預設為 default_event_processor 方法)並傳回布林值。當結果為 True 時,感測器將停止輪詢,否則它將繼續直到為 True 或逾時。

  • result_processor (Callable[[airflow.utils.context.Context, Any], Any]) – 進一步處理來自 MS Graph API 的回應的函數(預設為 lambda: context, response: response)。當 KiotaRequestAdapterHook 傳回的回應是位元組時,這些位元組將會被 base64 編碼為字串。

  • serializer (type[airflow.providers.microsoft.azure.triggers.msgraph.ResponseSerializer]) – 處理回應序列化的類別(預設為 ResponseSerializer)。位元組將會被 base64 編碼為字串,以便可以儲存為 XCom。

template_fields: collections.abc.Sequence[str] = ('url', 'response_type', 'path_parameters', 'url_template', 'query_parameters', 'headers',...[原始碼]
execute(context)[原始碼]

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

retry_execute(context)[原始碼]
execute_complete(context, event=None)[原始碼]

當 MSGraphSensor 完成執行時,執行回呼。

當 MSGraphTrigger 完成其執行時,此方法會自動執行。

這篇文章是否有幫助?