airflow.providers.google.cloud.operators.alloy_db¶

此模組包含 Google Cloud Alloy DB 運算子。

類¶

`AlloyDBBaseOperator`	所有 AlloyDB 運算子的基類。
`AlloyDBWriteBaseOperator`	寫入 AlloyDB 運算子的基類。
`AlloyDBCreateClusterOperator`	建立 Alloy DB 叢集。
`AlloyDBUpdateClusterOperator`	更新 Alloy DB 叢集。
`AlloyDBDeleteClusterOperator`	刪除 Alloy DB 叢集。
`AlloyDBCreateInstanceOperator`	在 Alloy DB 叢集中建立例項。
`AlloyDBUpdateInstanceOperator`	更新 Alloy DB 例項。
`AlloyDBDeleteInstanceOperator`	刪除 Alloy DB 例項。
`AlloyDBCreateUserOperator`	在 Alloy DB 叢集中建立使用者。
`AlloyDBUpdateUserOperator`	更新 Alloy DB 使用者。
`AlloyDBDeleteUserOperator`	刪除 Alloy DB 使用者。
`AlloyDBCreateBackupOperator`	在 Alloy DB 叢集中建立備份。
`AlloyDBUpdateBackupOperator`	更新 Alloy DB 備份。
`AlloyDBDeleteBackupOperator`	刪除 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)[source]¶

基類: 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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str] = ('project_id', 'location', 'gcp_conn_id')[source]¶

project_id[source]¶

location[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

property hook: airflow.providers.google.cloud.hooks.alloy_db.AlloyDbHook[source]¶

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBWriteBaseOperator(request_id=None, validate_request=False, *args, **kwargs)[source]¶

基類: 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][source]¶

request_id = None[source]¶

validate_request = False[source]¶

get_operation_result(operation)[source]¶

將操作結果作為 proto.Message 檢索。

如果設定了 validate_request 引數，則不執行任何操作，因此無需等待。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBCreateClusterOperator(cluster_id, cluster_configuration, is_secondary=False, *args, **kwargs)[source]¶

基類: 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) – 必需。指定要建立的叢集是 Primary（主）叢集還是 Secondary（從）叢集。請注意，如果設定為 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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links[source]¶

cluster_id[source]¶

cluster_configuration[source]¶

is_secondary = False[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBUpdateClusterOperator(cluster_id, cluster_configuration, update_mask=None, allow_missing=False, *args, **kwargs)[source]¶

基類: 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) – 可選。欄位掩碼用於指定在更新時應覆蓋 Cluster 資源中的哪些欄位。
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links[source]¶

cluster_id[source]¶

cluster_configuration[source]¶

update_mask = None[source]¶

allow_missing = False[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBDeleteClusterOperator(cluster_id, etag=None, force=False, *args, **kwargs)[source]¶

基類: 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) – 可選。Cluster 的當前 etag。如果提供了 etag 且與 Cluster 的當前 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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

cluster_id[source]¶

etag = None[source]¶

force = False[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBCreateInstanceOperator(cluster_id, instance_id, instance_configuration, is_secondary=False, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

在 Alloy DB 叢集中建立例項。

參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：建立例項

引數:

cluster_id (str) – 必需。用於建立例項的叢集 ID。
instance_id (str) – 必需。要建立的例項 ID。
instance_configuration (google.cloud.alloydb_v1.Instance | dict) – 必需。要建立的例項。有關更多詳細資訊，請參閱 API 文件：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Instance
is_secondary (bool) – 必需。指定要建立的例項是 Primary 還是 Secondary。請注意，如果設定為 True，則需在例項中指定 instance_type 欄位。
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links[source]¶

cluster_id[source]¶

instance_id[source]¶

instance_configuration[source]¶

is_secondary = False[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBUpdateInstanceOperator(cluster_id, instance_id, instance_configuration, update_mask=None, allow_missing=False, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

更新 Alloy DB 例項。

參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：更新例項

引數:

cluster_id (str) – 必需。叢集 ID。
instance_id (str) – 必需。要更新的例項 ID。
instance_configuration (google.cloud.alloydb_v1.Instance | dict) – 必需。要更新的例項。有關更多詳細資訊，請參閱 API 文件：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Instance
update_mask (google.protobuf.field_mask_pb2.FieldMask | dict | None) – 可選。欄位掩碼用於指定要在更新中覆蓋 Instance 資源中的哪些欄位。
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links[source]¶

cluster_id[source]¶

instance_id[source]¶

instance_configuration[source]¶

update_mask = None[source]¶

allow_missing = False[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBDeleteInstanceOperator(instance_id, cluster_id, etag=None, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

刪除 Alloy DB 例項。

參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：刪除例項

引數:

instance_id (str) – 必需。要刪除的例項 ID。
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 error。
project_id – 必需。使用服務的 Google Cloud 專案 ID。
location – 必需。使用服務的 Google Cloud 區域 ID。
gcp_conn_id – 可選。用於連線到 Google Cloud 的連線 ID。
retry – 可選。用於重試請求的重試物件。如果指定為 None，則不會重試請求。
timeout – 可選。等待請求完成的時間量（以秒為單位）。請注意，如果指定了 retry，則超時適用於每次單獨的嘗試。
metadata – 可選。提供給方法的附加元資料。
impersonation_chain – 可選的服務賬號，用於使用短期憑據模擬，或者用於獲取列表中最後一個賬號的 access_token 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

instance_id[source]¶

cluster_id[source]¶

etag = None[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBCreateUserOperator(user_id, user_configuration, cluster_id, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

在 Alloy DB 叢集中建立使用者。

參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：建立使用者

引數:

user_id (str) – 必需。要建立的使用者 ID。
user_configuration (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。
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links[source]¶

user_id[source]¶

user_configuration[source]¶

cluster_id[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBUpdateUserOperator(cluster_id, user_id, user_configuration, update_mask=None, allow_missing=False, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

更新 Alloy DB 使用者。

參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：更新使用者

引數:

user_id (str) – 必需。要更新的使用者 ID。
cluster_id (str) – 必需。叢集 ID。
user_configuration (google.cloud.alloydb_v1.User | dict) – 必需。要更新的使用者。有關更多詳細資訊，請參閱 API 文件：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.User
update_mask (google.protobuf.field_mask_pb2.FieldMask | dict | None) – 可選。欄位掩碼用於指定要在更新中覆蓋 User 資源中的哪些欄位。
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links[source]¶

cluster_id[source]¶

user_id[source]¶

user_configuration[source]¶

update_mask = None[source]¶

allow_missing = False[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBDeleteUserOperator(user_id, cluster_id, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

刪除 Alloy DB 使用者。

參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：刪除使用者

引數:

user_id (str) – 必需。要刪除的使用者 ID。
cluster_id (str) – 必需。叢集 ID。
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

user_id[source]¶

cluster_id[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBCreateBackupOperator(backup_id, backup_configuration, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

在 Alloy DB 叢集中建立備份。

參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：建立備份

引數:

backup_id (str) – 必需。要建立的備份 ID。
backup_configuration (google.cloud.alloydb_v1.Backup | dict) – 必需。要建立的備份。有關更多詳細資訊，請參閱 API 文件：https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Backup
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links[source]¶

backup_id[source]¶

backup_configuration[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBUpdateBackupOperator(backup_id, backup_configuration, update_mask=None, allow_missing=False, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

更新 Alloy DB 備份。

參閱

有關如何使用此運算子的更多資訊，請參閱指南：更新備份

引數:

backup_id (str) – 必需。要更新的備份的 ID。
backup_configuration (google.cloud.alloydb_v1.Backup | dict) – 必需。要更新的備份。更多詳情請參閱 API 文件： https://cloud.google.com/python/docs/reference/alloydb/latest/google.cloud.alloydb_v1.types.Backup
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links[source]¶

backup_id[source]¶

backup_configuration[source]¶

update_mask = None[source]¶

allow_missing = False[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。

class airflow.providers.google.cloud.operators.alloy_db.AlloyDBDeleteBackupOperator(backup_id, *args, **kwargs)[source]¶

基類: AlloyDBWriteBaseOperator

刪除 Alloy DB 備份。

參閱

有關如何使用此運算子的更多資訊，請參閱指南：刪除備份

引數:

backup_id (str) – 必需。要刪除的備份的 ID。
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 的鏈式賬號列表，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須向原始賬號授予 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予 Service Account Token Creator IAM 角色，列表中第一個賬號將此角色授予原始賬號（模板化）。

template_fields: collections.abc.Sequence[str][source]¶

backup_id[source]¶

execute(context)[source]¶

建立運算子時派生。

上下文是與渲染 jinja 模板時使用的字典相同。

有關更多上下文，請參閱 get_template_context。