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]]) – 可選。應隨請求一起傳送作為元資料的字串。

本條目是否有幫助？