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

此模組允許您連線到 Google Discovery API 服務並查詢它。

模組內容¶

類別¶

GoogleDiscoveryApiHook

用於 Google API Discovery Service 的 Hook。

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 Service 的 Hook。

參數

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 Client Library 中註冊的任何 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`¶