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, 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) – 作为字符串的预期响应返回类型。可能的值为：bytes、str、int、float、bool 和 datetime（默认为 None）。
method (str) – 用于进行 REST 调用的 HTTP 方法（默认为 GET）。
conn_id (str) – 用于运行此操作符的 HTTP 连接 ID（已模板化）。
proxies (dict | None) – 一个定义要使用的 HTTP 代理的字典（默认为 None）。
api_version (msgraph_core.APIVersion | str | None) – 要使用的 Microsoft Graph API 的 API 版本（默认为 v1）。你可以传递一个名为 APIVersion 的枚举，它有两个可能的成员 v1 和 beta，或者你可以传递一个字符串，如 v1.0 或 beta。
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',...[源代码]¶