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

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

Google Alloy DB Hook。

get_alloy_db_admin_client()[source]

获取 AlloyDB 客户端。

wait_for_operation(timeout, operation)[source]

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

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

创建 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。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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=())[source]

创建二级 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。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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=())[source]

获取 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=())[source]

更新 Alloy DB 集群。

另请参阅

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

参数:

  • 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) – 可选。字段掩码用于指定要在更新中覆盖 Cluster 资源中的哪些字段。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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=())[source]

删除 Alloy DB 集群。

另请参阅

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

参数:

  • cluster_id (str) – 必需。要删除的集群的 ID。

  • location (str) – 必需。集群所在的 Google Cloud 区域的 ID。

  • project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • etag (str | None) – 可选。Cluster 的当前 etag。如果提供了 etag 并且与 Cluster 的当前 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]]) – 可选。应随请求一起发送作为元数据的字符串。

create_instance(cluster_id, instance_id, instance, location, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

在给定的 Alloy DB 集群中创建实例。

另请参阅

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

参数:

  • cluster_id (str) – 必需。要创建实例的集群 ID。

  • instance_id (str) – 必需。要创建的实例的 ID。

  • instance (google.cloud.alloydb_v1.Instance | dict) – 必需。要创建的实例。有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Instance

  • location (str) – 必需。集群所在的 Google Cloud 区域的 ID。

  • project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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_instance(cluster_id, instance_id, instance, location, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

在给定的 Alloy DB 集群中创建二级实例。

另请参阅

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

参数:

  • cluster_id (str) – 必需。要创建实例的集群 ID。

  • instance_id (str) – 必需。要创建的实例的 ID。

  • instance (google.cloud.alloydb_v1.Instance | dict) – 必需。要创建的实例。有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Instance

  • location (str) – 必需。集群所在的 Google Cloud 区域的 ID。

  • project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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_instance(cluster_id, instance_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

获取 Alloy DB 实例。

另请参阅

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

参数:

  • cluster_id (str) – 必需。集群的 ID。

  • instance_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_instance(cluster_id, instance_id, instance, location, update_mask=None, project_id=PROVIDE_PROJECT_ID, allow_missing=False, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

更新 Alloy DB 实例。

另请参阅

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

参数:

  • cluster_id (str) – 必需。集群的 ID。

  • instance_id (str) – 必需。要更新的集群的 ID。

  • instance (google.cloud.alloydb_v1.Instance | dict) – 必需。要更新的集群。有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Instance

  • location (str) – 必需。集群所在的 Google Cloud 区域的 ID。

  • update_mask (google.protobuf.field_mask_pb2.FieldMask | dict | None) – 可选。字段掩码用于指定要在更新中覆盖 Instance 资源中的哪些字段。

  • request_id (str | None) – 可选。现有请求对象的 ID。:param request_id: 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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_instance(instance_id, cluster_id, location, project_id=PROVIDE_PROJECT_ID, request_id=None, etag=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

删除 Alloy DB 实例。

另请参阅

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

参数:

  • instance_id (str) – 必需。要删除的实例的 ID。

  • cluster_id (str) – 必需。集群的 ID。

  • location (str) – 必需。实例所在的 Google Cloud 区域的 ID。

  • project_id (str) – 可选。实例所在的 Google Cloud 项目的 ID。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • etag (str | None) – 可选。Instance 的当前 etag。如果提供了 etag 并且与 Instance 的当前 etag 不匹配，则会阻止删除并返回 ABORTED 错误。

  • 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_user(user_id, user, cluster_id, location, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

在给定的 Alloy DB 集群中创建用户。

另请参阅

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

参数:

  • user_id (str) – 必需。要创建的用户的 ID。

  • user (google.cloud.alloydb_v1.User | dict) – 必需。要创建的用户。有关更多详细信息，请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.User

  • cluster_id (str) – 必需。要创建用户的集群的 ID。

  • location (str) – 必需。集群所在的 Google Cloud 区域的 ID。

  • project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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_user(user_id, cluster_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

在给定的 Alloy DB 集群中获取用户。

另请参阅

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

参数:

  • user_id (str) – 必需。要创建的用户的 ID。

  • 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_user(cluster_id, user_id, user, location, update_mask=None, allow_missing=False, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

更新 Alloy DB 用户。

另请参阅

更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.UpdateUserRequest

参数:

  • cluster_id (str) – 必需。集群的 ID。

  • user_id (str) – 必填。要更新的用户 ID。

  • user (google.cloud.alloydb_v1.User | dict) – 必填。要更新的用户。更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.User

  • location (str) – 必需。集群所在的 Google Cloud 区域的 ID。

  • update_mask (google.protobuf.field_mask_pb2.FieldMask | dict | None) – 可选。字段掩码用于指定在更新时 User 资源中要覆盖的字段。

  • request_id (str | None) – 可选。现有请求对象的 ID。:param request_id: 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • validate_only (bool) – 可选。如果设置，则执行请求验证，但不实际执行创建请求。

  • allow_missing (bool) – 可选。如果设置为 true，即使找不到集群，更新也会成功。在这种情况下，会创建一个新集群并忽略 update_mask。

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

delete_user(user_id, cluster_id, location, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

删除 Alloy DB 用户。

另请参阅

更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.DeleteUserRequest

参数:

  • user_id (str) – 必填。要删除的用户 ID。

  • cluster_id (str) – 必需。集群的 ID。

  • location (str) – 必需。实例所在的 Google Cloud 区域的 ID。

  • project_id (str) – 可选。实例所在的 Google Cloud 项目的 ID。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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_backup(backup_id, backup, location, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

在指定的 Alloy DB 集群中创建备份。

另请参阅

更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.CreateBackupRequest

参数:

  • backup_id (str) – 必填。要创建的备份 ID。

  • backup (google.cloud.alloydb_v1.Backup | dict) – 必填。要创建的备份。更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Backup

  • location (str) – 必需。集群所在的 Google Cloud 区域的 ID。

  • project_id (str) – 可选。集群所在的 Google Cloud 项目的 ID。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • 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_backup(backup_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

获取指定 Alloy DB 集群中的备份。

另请参阅

更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.GetBackupRequest

参数:

  • backup_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_backup(backup_id, backup, location, update_mask=None, allow_missing=False, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

更新 Alloy DB 备份。

另请参阅

更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.UpdateBackupRequest

参数:

  • backup_id (str) – 必填。要更新的备份 ID。

  • backup (google.cloud.alloydb_v1.Backup | dict) – 必填。要更新的备份。更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Backup

  • location (str) – 必需。集群所在的 Google Cloud 区域的 ID。

  • update_mask (google.protobuf.field_mask_pb2.FieldMask | dict | None) – 可选。字段掩码用于指定在更新时 Backup 资源中要覆盖的字段。

  • request_id (str | None) – 可选。现有请求对象的 ID。:param request_id: 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

  • validate_only (bool) – 可选。如果设置，则执行请求验证，但不实际执行创建请求。

  • allow_missing (bool) – 可选。如果设置为 true，即使找不到集群，更新也会成功。在这种情况下，会创建一个新集群并忽略 update_mask。

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

delete_backup(backup_id, location, project_id=PROVIDE_PROJECT_ID, request_id=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

删除 Alloy DB 备份。

另请参阅

更多详情请参阅 API 文档：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.DeleteBackupRequest

参数:

  • backup_id (str) – 必填。要删除的备份 ID。

  • location (str) – 必需。实例所在的 Google Cloud 区域的 ID。

  • project_id (str) – 可选。实例所在的 Google Cloud 项目的 ID。

  • request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，这样如果您必须重试请求，如果服务器已完成该请求，则会忽略该请求。服务器保证至少在第一次请求后的 60 分钟内有效。例如，考虑一个场景：您发出初始请求并且请求超时。如果您使用相同的请求 ID 再次发出请求，服务器可以检查是否收到具有相同请求 ID 的原始操作，如果是，则忽略第二个请求。这可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，但零 UUID (00000000-0000-0000-0000-000000000000) 不受支持。

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

本条目是否有帮助？