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

模块包含 Google Alloy DB Hook。

模块内容¶

类¶

AlloyDbHook

Google Alloy DB Hook。

class airflow.providers.google.cloud.hooks.alloy_db.AlloyDbHook(*args, **kwargs)[源代码]¶

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

Google Alloy DB Hook。

get_alloy_db_admin_client()[源代码]¶

检索 AlloyDB 客户端。

wait_for_operation(timeout, operation)[源代码]¶

等待长时间运行的操作完成。

create_cluster(cluster_id, cluster, location, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[源代码]¶

创建一个 Alloy DB 集群。

另请参阅

有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.CreateClusterRequest

参数

cluster_id (str) – 必需。要创建的集群的 ID。
cluster (google.cloud.alloydb_v1.Cluster | dict) – 必需。要创建的集群。有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Cluster
location (str) – 必需。集群所在的 Google Cloud 区域的 ID。
project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。
request_id (str | None) – 可选。现有请求对象的 ID。
validate_only (bool) – 可选。如果设置，则执行请求验证，但实际上不执行创建请求。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选。指定应重试哪些错误（如果有）。
timeout (float | None) – 可选。此请求的超时时间。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选。应随请求一起作为元数据发送的字符串。

create_secondary_cluster(cluster_id, cluster, location, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[源代码]¶

创建一个辅助 Alloy DB 集群。

另请参阅

有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.CreateClusterRequest

参数

cluster_id (str) – 必需。要创建的集群的 ID。
cluster (google.cloud.alloydb_v1.Cluster | dict) – 必需。要创建的集群。有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Cluster
location (str) – 必需。集群所在的 Google Cloud 区域的 ID。
project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。
request_id (str | None) – 可选。现有请求对象的 ID。
validate_only (bool) – 可选。如果设置，则执行请求验证，但实际上不执行创建请求。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选。指定应重试哪些错误（如果有）。
timeout (float | None) – 可选。此请求的超时时间。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选。应随请求一起作为元数据发送的字符串。

get_cluster(cluster_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[源代码]¶

检索一个 Alloy DB 集群。

另请参阅

有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.GetClusterRequest

参数

cluster_id (str) – 必需。要创建的集群的 ID。
location (str) – 必需。集群所在的 Google Cloud 区域的 ID。
project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选。指定应重试哪些错误（如果有）。
timeout (float | None) – 可选。此请求的超时时间。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选。应随请求一起作为元数据发送的字符串。

update_cluster(cluster_id, cluster, location, update_mask=None, project_id=PROVIDE_PROJECT_ID, allow_missing=False, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[源代码]¶

更新一个 Alloy DB 集群。

另请参阅

参数

cluster_id (str) – 必需。要更新的集群的 ID。
cluster (google.cloud.alloydb_v1.Cluster | dict) – 必需。要创建的集群。有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Cluster
location (str) – 必需。集群所在的 Google Cloud 区域的 ID。
update_mask (google.protobuf.field_mask_pb2.FieldMask | dict | None) – 可选。字段掩码用于指定更新时要覆盖的集群资源中的字段。
request_id (str | None) – 可选。现有请求对象的 ID。
validate_only (bool) – 可选。如果设置，则执行请求验证，但实际上不执行创建请求。
project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。
allow_missing (bool) – 可选。如果设置为 true，即使未找到集群，更新也会成功。在这种情况下，将创建一个新集群，并忽略 update_mask。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选。指定应重试哪些错误（如果有）。
timeout (float | None) – 可选。此请求的超时时间。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选。应随请求一起作为元数据发送的字符串。

delete_cluster(cluster_id, location, project_id=PROVIDE_PROJECT_ID, request_id=None, etag=None, validate_only=False, force=False, retry=DEFAULT, timeout=None, metadata=())[源代码]¶

删除 Alloy DB 集群。

另请参阅

参数

cluster_id (str) – 必需。要删除的集群的 ID。
location (str) – 必需。集群所在的 Google Cloud 区域的 ID。
project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。
request_id (str | None) – 可选。现有请求对象的 ID。
etag (str | None) – 可选。集群的当前 etag。如果提供了 etag 并且与集群的当前 etag 不匹配，则删除将被阻止并返回 ABORTED 错误。
validate_only (bool) – 可选。如果设置，则执行请求验证，但实际上不执行创建请求。
force (bool) – 可选。是否级联删除给定集群的子实例。
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.alloy_db¶

模块内容¶

类¶

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