airflow.providers.microsoft.azure.triggers.msgraph

Module Contents

Classes

ResponseSerializer

ResponseSerializer serializes the response as a string.

MSGraphTrigger

A Microsoft Graph API trigger which allows you to execute an async REST call to the Microsoft Graph API.
class airflow.providers.microsoft.azure.triggers.msgraph.ResponseSerializer(encoding=None)[source]

ResponseSerializer serializes the response as a string.

serialize(response)[source]
deserialize(response)[source]
class airflow.providers.microsoft.azure.triggers.msgraph.MSGraphTrigger(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, timeout=None, proxies=None, api_version=None, serializer=ResponseSerializer)[source]

Bases: airflow.triggers.base.BaseTrigger

A Microsoft Graph API trigger which allows you to execute an async REST call to the Microsoft Graph API.

Parameters

  • url (str) – The url being executed on the Microsoft Graph API (templated).

  • response_type (kiota_http.httpx_request_adapter.ResponseType | None) – The expected return type of the response as a string. Possible value are: bytes, str, int, float, bool and datetime (default is None).

  • method (str) – The HTTP method being used to do the REST call (default is GET).

  • conn_id (str) – The HTTP Connection ID to run the operator against (templated).

  • timeout (float | None) – The HTTP timeout being used by the KiotaRequestAdapter (default is None). When no timeout is specified or set to None then there is no HTTP timeout on each request.

  • proxies (dict | None) – A dict defining the HTTP proxies to be used (default is None).

  • api_version (msgraph_core.APIVersion | str | None) – The API version of the Microsoft Graph API to be used (default is v1). You can pass an enum named APIVersion which has 2 possible members v1 and beta, or you can pass a string as v1.0 or beta.

  • serializer (type[ResponseSerializer]) – Class which handles response serialization (default is ResponseSerializer). Bytes will be base64 encoded into a string, so it can be stored as an XCom.

property conn_id: str[source]
property timeout: float | None[source]
property proxies: dict | None[source]
property api_version: msgraph_core.APIVersion | str[source]
template_fields: collections.abc.Sequence[str] = ('url', 'response_type', 'path_parameters', 'url_template', 'query_parameters', 'headers',...[source]
classmethod resolve_type(value, default)[source]
serialize()[source]

Serialize the HttpTrigger arguments and classpath.

get_conn()[source]
async run()[source]

Make a series of asynchronous HTTP calls via a KiotaRequestAdapterHook.

Was this entry helpful?