airflow.providers.google.cloud.hooks.secret_manager¶

此模組包含一個 Secret Manager hook。

類¶

GoogleCloudSecretManagerHook

適用於 Google Cloud Secret Manager API 的 Hook。

模組內容¶

class airflow.providers.google.cloud.hooks.secret_manager.GoogleCloudSecretManagerHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]¶

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

適用於 Google Cloud Secret Manager API 的 Hook。

請參閱 https://cloud.google.com/secret-manager

property client[原始碼]¶

建立一個 Secret Manager 客戶端。

返回:: Secret Manager 客戶端。

get_conn()[原始碼]¶

檢索與 Secret Manager 的連線。

返回:: Secret Manager 客戶端。
返回型別:: google.cloud.secretmanager_v1.SecretManagerServiceClient

create_secret(project_id, secret_id, secret=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]¶

建立一個 secret。

另請參閱

引數:

project_id (str) – 必填。擁有此任務的 GCP 專案 ID。如果設定為 None 或缺失，則使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要建立的 secret 的 ID。
secret (dict | google.cloud.secretmanager_v1.Secret | None) – 可選。要建立的 Secret 物件。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可選。指定哪些錯誤（如果有）應重試。
timeout (float | None) – 可選。此請求的超時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可選。應隨請求一起傳送作為元資料的字串列表。

返回:

Secret 物件。

返回型別:

google.cloud.secretmanager_v1.Secret

add_secret_version(project_id, secret_id, secret_payload=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]¶

向 secret 新增一個版本。

另請參閱

引數:

project_id (str) – 必填。擁有此任務的 GCP 專案 ID。如果設定為 None 或缺失，則使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要建立的 secret 的 ID。
secret_payload (dict | google.cloud.secretmanager_v1.SecretPayload | None) – 可選。一個 secret 載荷。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可選。指定哪些錯誤（如果有）應重試。
timeout (float | None) – 可選。此請求的超時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可選。應隨請求一起傳送作為元資料的字串列表。

返回:

Secret 版本物件。

返回型別:

google.cloud.secretmanager_v1.SecretVersion

list_secrets(project_id, page_size=0, page_token=None, secret_filter=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]¶

列出 secrets。

另請參閱

引數:

project_id (str) – 必填。擁有此任務的 GCP 專案 ID。如果設定為 None 或缺失，則使用 GCP 連線中的預設 project_id。
page_size (int) – 可選，列表中返回的結果數量。
page_token (str | None) – 可選，用於跳到列表中特定位置的 token。
secret_filter (str | None) – 可選。過濾字串。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可選。指定哪些錯誤（如果有）應重試。
timeout (float | None) – 可選。此請求的超時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可選。應隨請求一起傳送作為元資料的字串列表。

返回:

Secret 列表物件。

返回型別:

google.cloud.secretmanager_v1.services.secret_manager_service.pagers.ListSecretsPager

secret_exists(project_id, secret_id)[原始碼]¶

檢查 secret 是否存在。

引數:

project_id (str) – 必填。擁有此任務的 GCP 專案 ID。如果設定為 None 或缺失，則使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要查詢的 secret 的 ID。

返回:

如果 secret 存在則為 True，否則為 False。

返回型別:

bool

access_secret(project_id, secret_id, secret_version='latest', retry=DEFAULT, timeout=None, metadata=())[原始碼]¶

訪問 secret 版本。

另請參閱

引數:

project_id (str) – 必填。擁有此任務的 GCP 專案 ID。如果設定為 None 或缺失，則使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要訪問的 secret 的 ID。
secret_version (str) – 可選。要訪問的 secret 版本。預設：最新版本 (latest)。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可選。指定哪些錯誤（如果有）應重試。
timeout (float | None) – 可選。此請求的超時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可選。應隨請求一起傳送作為元資料的字串列表。

返回:

訪問 secret 版本響應物件。

返回型別:

google.cloud.secretmanager_v1.AccessSecretVersionResponse

delete_secret(project_id, secret_id, retry=DEFAULT, timeout=None, metadata=())[原始碼]¶

刪除一個 secret。

另請參閱

引數:

project_id (str) – 必填。擁有此任務的 GCP 專案 ID。如果設定為 None 或缺失，則使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要刪除的 secret 的 ID。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可選。指定哪些錯誤（如果有）應重試。
timeout (float | None) – 可選。此請求的超時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可選。應隨請求一起傳送作為元資料的字串列表。

返回:

訪問 secret 版本響應物件。

返回型別:

無