`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)[源代码]¶

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

用于 Google Cloud Secret Manager API 的 Hook。

请参阅 https://cloud.google.com/secret-manager

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=())[源代码]¶

创建一个密钥。

另请参阅

参数

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=())[源代码]¶

为密钥添加一个版本。

另请参阅

参数

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=())[源代码]¶

列出密钥。

另请参阅

参数

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)[源代码]¶

检查密钥是否存在。

参数

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=())[源代码]¶

访问密钥版本。

另请参阅

参数

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=())[源代码]¶

删除一个密钥。

另请参阅

参数

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]]) – 可选。应与请求一起作为元数据发送的字符串。

返回

访问密钥版本响应对象。

返回类型

无

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

模块内容¶

类¶

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