airflow.providers.google.cloud.operators.alloy_db¶
此模組包含 Google Cloud Alloy DB 運算子。
模組內容¶
類別¶
所有 AlloyDB 運算子的基礎類別。 |
|
用於寫入 AlloyDB 運算子的基礎類別。 |
|
建立 Alloy DB 叢集。 |
|
更新 Alloy DB 叢集。 |
|
刪除 Alloy DB 叢集。 |
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBBaseOperator(project_id, location, gcp_conn_id='google_cloud_default', retry=DEFAULT, timeout=None, metadata=(), impersonation_chain=None, *args, **kwargs)[原始碼]¶
基底類別：
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator所有 AlloyDB 運算子的基礎類別。
- 參數
project_id (str) – 必要項目。使用服務的 Google Cloud 專案 ID。
location (str) – 必要項目。使用服務的 Google Cloud 區域 ID。
gcp_conn_id (str) – 選用項目。用於連線至 Google Cloud 的連線 ID。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 選用項目。用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – 選用項目。等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每次個別嘗試。
metadata (collections.abc.Sequence[tuple[str, str]]) – 選用項目。提供給方法的其他中繼資料。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用項目。要使用短期憑證模擬的服務帳戶，或取得清單中最後一個帳戶的 access_token 所需的串鏈帳戶清單，該帳戶將在請求中模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，清單中的第一個帳戶將此角色授予原始帳戶 (已範本化)。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'location', 'gcp_conn_id')[原始碼]¶
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBWriteBaseOperator(request_id=None, validate_request=False, *args, **kwargs)[原始碼]¶
基底類別：
AlloyDBBaseOperator用於寫入 AlloyDB 運算子的基礎類別。
這些運算子執行物件 (而非資料庫內部) 的建立、更新或刪除作業。
- 參數
request_id (str | None) – 選用項目。用於識別請求的選用請求 ID。指定唯一的請求 ID，以便在您必須重試請求時，如果伺服器已完成請求，則會忽略該請求。伺服器保證自第一個請求起至少 60 分鐘。例如，假設您發出初始請求，但請求逾時。如果您再次使用相同的請求 ID 發出請求，伺服器可以檢查是否已收到具有相同請求 ID 的原始作業，如果已收到，則會忽略第二個請求。這可防止用戶端意外建立重複的承諾。請求 ID 必須是有效的 UUID，但零 UUID 不受支援 (00000000-0000-0000-0000-000000000000)。
validate_request (bool) – 選用項目。如果設定，則執行請求驗證，但實際上不會執行請求。
- template_fields: collections.abc.Sequence[str][原始碼]¶
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBCreateClusterOperator(cluster_id, cluster_configuration, is_secondary=False, *args, **kwargs)[原始碼]¶
基底類別：
AlloyDBWriteBaseOperator建立 Alloy DB 叢集。
另請參閱
如需如何使用此運算子的詳細資訊，請參閱指南： 建立叢集
- 參數
cluster_id (str) – 必要項目。要建立的叢集 ID。
cluster_configuration (google.cloud.alloydb_v1.Cluster | dict) – 必要項目。要建立的叢集。如需更多詳細資訊，請參閱 API 文件： https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Cluster
is_secondary (bool) – 必要項目。指定要建立的叢集是主要叢集還是次要叢集。請注意，如果設定為 True，則在叢集中指定 secondary_config 欄位，使建立的次要叢集指向主要叢集。
request_id – 選用項目。用於識別請求的選用請求 ID。指定唯一的請求 ID，以便在您必須重試請求時，如果伺服器已完成請求，則會忽略該請求。伺服器保證自第一個請求起至少 60 分鐘。例如，假設您發出初始請求，但請求逾時。如果您再次使用相同的請求 ID 發出請求，伺服器可以檢查是否已收到具有相同請求 ID 的原始作業，如果已收到，則會忽略第二個請求。這可防止用戶端意外建立重複的承諾。請求 ID 必須是有效的 UUID，但零 UUID 不受支援 (00000000-0000-0000-0000-000000000000)。
validate_request – 選用項目。如果設定，則執行請求驗證，但實際上不會執行請求。
project_id – 必要項目。使用服務的 Google Cloud 專案 ID。
location – 必要項目。使用服務的 Google Cloud 區域 ID。
gcp_conn_id – 選用項目。用於連線至 Google Cloud 的連線 ID。
retry – 選用項目。用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout – 選用項目。等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每次個別嘗試。
metadata – 選用項目。提供給方法的其他中繼資料。
impersonation_chain – 選用項目。要使用短期憑證模擬的服務帳戶，或取得清單中最後一個帳戶的 access_token 所需的串鏈帳戶清單，該帳戶將在請求中模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，清單中的第一個帳戶將此角色授予原始帳戶 (已範本化)。
- template_fields: collections.abc.Sequence[str][原始碼]¶
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBUpdateClusterOperator(cluster_id, cluster_configuration, update_mask=None, allow_missing=False, *args, **kwargs)[原始碼]¶
基底類別：
AlloyDBWriteBaseOperator更新 Alloy DB 叢集。
另請參閱
如需如何使用此運算子的詳細資訊，請參閱指南： 更新叢集
- 參數
cluster_id (str) – 必要項目。要建立的叢集 ID。
cluster_configuration (google.cloud.alloydb_v1.Cluster | dict) – 必要項目。要更新的叢集。如需更多詳細資訊，請參閱 API 文件： https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Cluster
update_mask (google.protobuf.field_mask_pb2.FieldMask | dict | None) – 選用項目。欄位遮罩用於指定要由更新覆寫的叢集資源中的欄位。
request_id – 選用項目。用於識別請求的選用請求 ID。指定唯一的請求 ID，以便在您必須重試請求時，如果伺服器已完成請求，則會忽略該請求。伺服器保證自第一個請求起至少 60 分鐘。例如，假設您發出初始請求，但請求逾時。如果您再次使用相同的請求 ID 發出請求，伺服器可以檢查是否已收到具有相同請求 ID 的原始作業，如果已收到，則會忽略第二個請求。這可防止用戶端意外建立重複的承諾。請求 ID 必須是有效的 UUID，但零 UUID 不受支援 (00000000-0000-0000-0000-000000000000)。
validate_request – 選用項目。如果設定，則執行請求驗證，但實際上不會執行請求。
allow_missing (bool) – 選用項目。如果設定為 true，即使找不到叢集，更新也會成功。在這種情況下，會建立新的叢集，並忽略 update_mask。
project_id – 必要項目。使用服務的 Google Cloud 專案 ID。
location – 必要項目。使用服務的 Google Cloud 區域 ID。
gcp_conn_id – 選用項目。用於連線至 Google Cloud 的連線 ID。
retry – 選用項目。用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout – 選用項目。等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每次個別嘗試。
metadata – 選用項目。提供給方法的其他中繼資料。
impersonation_chain – 選用項目。要使用短期憑證模擬的服務帳戶，或取得清單中最後一個帳戶的 access_token 所需的串鏈帳戶清單，該帳戶將在請求中模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，清單中的第一個帳戶將此角色授予原始帳戶 (已範本化)。
- template_fields: collections.abc.Sequence[str][原始碼]¶
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBDeleteClusterOperator(cluster_id, etag=None, force=False, *args, **kwargs)[原始碼]¶
基底類別：
AlloyDBWriteBaseOperator刪除 Alloy DB 叢集。
另請參閱
如需如何使用此運算子的詳細資訊，請參閱指南： 刪除叢集
- 參數
cluster_id (str) – 必要項目。要建立的叢集 ID。
request_id – 選用項目。用於識別請求的選用請求 ID。指定唯一的請求 ID，以便在您必須重試請求時，如果伺服器已完成請求，則會忽略該請求。伺服器保證自第一個請求起至少 60 分鐘。例如，假設您發出初始請求，但請求逾時。如果您再次使用相同的請求 ID 發出請求，伺服器可以檢查是否已收到具有相同請求 ID 的原始作業，如果已收到，則會忽略第二個請求。這可防止用戶端意外建立重複的承諾。請求 ID 必須是有效的 UUID，但零 UUID 不受支援 (00000000-0000-0000-0000-000000000000)。
validate_request – 選用項目。如果設定，則執行請求驗證，但實際上不會執行請求。
etag (str | None) – 選用項目。叢集的目前 etag。如果提供 etag，且與叢集的目前 etag 不符，則會封鎖刪除並傳回 ABORTED 錯誤。
force (bool) – 選用項目。是否串聯刪除給定叢集的子執行個體。
project_id – 必要項目。使用服務的 Google Cloud 專案 ID。
location – 必要項目。使用服務的 Google Cloud 區域 ID。
gcp_conn_id – 選用項目。用於連線至 Google Cloud 的連線 ID。
retry – 選用項目。用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout – 選用項目。等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每次個別嘗試。
metadata – 選用項目。提供給方法的其他中繼資料。
impersonation_chain – 選用項目。要使用短期憑證模擬的服務帳戶，或取得清單中最後一個帳戶的 access_token 所需的串鏈帳戶清單，該帳戶將在請求中模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，清單中的第一個帳戶將此角色授予原始帳戶 (已範本化)。
- template_fields: collections.abc.Sequence[str][原始碼]¶