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 版本响应对象。

返回类型:

无