`airflow.providers.google.common.hooks.discovery_api`¶

此模块允许您连接到 Google Discovery API 服务并查询它。

模块内容¶

类¶

GoogleDiscoveryApiHook

使用 Google API Discovery 服务的钩子。

class airflow.providers.google.common.hooks.discovery_api.GoogleDiscoveryApiHook(api_service_name, api_version, gcp_conn_id='google_cloud_default', impersonation_chain=None)[源代码]¶

基类： airflow.providers.google.common.hooks.base_google.GoogleBaseHook

使用 Google API Discovery 服务的钩子。

参数

api_service_name (str) – 获取数据所需的 api 服务名称，例如 ‘youtube’。
api_version (str) – 将被请求的 api 版本，例如 ‘v3’。
gcp_conn_id (str) – 获取连接信息时要使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据模拟，或获取列表中最后一个帐户的 access_token 所需的链接帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须向原始帐户授予“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的标识必须向紧邻的前一个标识授予“服务帐户令牌创建者”IAM 角色，列表中的第一个帐户将此角色授予原始帐户。

get_conn()[源代码]¶

为给定的 api 服务名称和凭据创建经过身份验证的 api 客户端。

返回: 经过身份验证的 api 服务。
返回类型: googleapiclient.discovery.Resource

query(endpoint, data, paginate=False, num_retries=0)[源代码]¶

创建对 Google API 客户端库中注册的任何 Google API 的动态 API 调用并查询它。

参数

endpoint (str) –
客户端库中 API 调用执行方法的路径。例如：‘analyticsreporting.reports.batchGet’

另请参阅

https://developers.google.com/apis-explorer 获取有关可用方法的更多信息。
data (dict) – 给定端点特定请求所需的数据（端点参数）。
paginate (bool) – 如果设置为 True，它将收集所有数据页面。
num_retries (int) – 定义请求失败时的重试次数。

返回

从传递的端点获得的 API 响应。

返回类型

dict

airflow.providers.google.common.hooks.discovery_api¶

模块内容¶

类¶

`airflow.providers.google.common.hooks.discovery_api`¶