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。