`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)[source]¶

基底類別: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Google Cloud Secret Manager API 的 Hook。

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

client()[source]¶

建立 Secret Manager Client。

回傳: Secret Manager Client。

get_conn()[source]¶

擷取與 Secret Manager 的連線。

回傳: Secret Manager Client。
回傳類型: google.cloud.secretmanager_v1.SecretManagerServiceClient

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

建立密鑰。

另請參閱

參數

project_id (str) – 必填。擁有此工作的 GCP 專案 ID。如果設定為 None 或遺失，則會使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要建立的密鑰 ID。
secret (dict | google.cloud.secretmanager_v1.Secret | None) – 選填。要建立的密鑰。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 選填。指定應重試哪些錯誤 (若有)。
timeout (float | None) – 選填。此請求的逾時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 選填。應與請求一起傳送做為中繼資料的字串。

回傳

密鑰物件。

回傳類型

google.cloud.secretmanager_v1.Secret

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

為密鑰新增版本。

另請參閱

參數

project_id (str) – 必填。擁有此工作的 GCP 專案 ID。如果設定為 None 或遺失，則會使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要建立的密鑰 ID。
secret_payload (dict | google.cloud.secretmanager_v1.SecretPayload | None) – 選填。密鑰酬載。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 選填。指定應重試哪些錯誤 (若有)。
timeout (float | None) – 選填。此請求的逾時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 選填。應與請求一起傳送做為中繼資料的字串。

回傳

密鑰版本物件。

回傳類型

google.cloud.secretmanager_v1.SecretVersion

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

列出密鑰。

另請參閱

參數

project_id (str) – 必填。擁有此工作的 GCP 專案 ID。如果設定為 None 或遺失，則會使用 GCP 連線中的預設 project_id。
page_size (int) – 選填，要在清單中傳回的結果數量。
page_token (str | None) – 選填，用於跳至清單中特定位置的權杖。
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]]) – 選填。應與請求一起傳送做為中繼資料的字串。

回傳

密鑰清單物件。

回傳類型

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

secret_exists(project_id, secret_id)[source]¶

檢查密鑰是否存在。

參數

project_id (str) – 必填。擁有此工作的 GCP 專案 ID。如果設定為 None 或遺失，則會使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要尋找的密鑰 ID。

回傳

如果密鑰存在則為 True，否則為 False。

回傳類型

bool

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

存取密鑰版本。

另請參閱

參數

project_id (str) – 必填。擁有此工作的 GCP 專案 ID。如果設定為 None 或遺失，則會使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要存取的密鑰 ID。
secret_version (str) – 選填。要存取的密鑰版本。預設值：latest。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 選填。指定應重試哪些錯誤 (若有)。
timeout (float | None) – 選填。此請求的逾時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 選填。應與請求一起傳送做為中繼資料的字串。

回傳

存取密鑰版本回應物件。

回傳類型

google.cloud.secretmanager_v1.AccessSecretVersionResponse

delete_secret(project_id, secret_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除密鑰。

另請參閱

參數

project_id (str) – 必填。擁有此工作的 GCP 專案 ID。如果設定為 None 或遺失，則會使用 GCP 連線中的預設 project_id。
secret_id (str) – 必填。要刪除的密鑰 ID。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 選填。指定應重試哪些錯誤 (若有)。
timeout (float | None) – 選填。此請求的逾時時間。
metadata (collections.abc.Sequence[tuple[str, str]]) – 選填。應與請求一起傳送做為中繼資料的字串。

回傳

存取密鑰版本回應物件。

回傳類型

None

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

模組內容¶

類別¶

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