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]¶