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)[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 所需的链接帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予发起帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的标识必须向紧邻的前一个标识授予“服务帐户令牌创建者”IAM 角色，并且列表中的第一个帐户向发起帐户授予此角色（已模板化）。
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBWriteBaseOperator(request_id=None, validate_request=False, *args, **kwargs)[source]¶
-
用于写入 AlloyDB 运算符的基类。
这些运算符执行创建、更新或删除操作。针对对象（不在数据库内部）。
- 参数
request_id (str | None) – 可选。用于标识请求的可选请求 ID。指定唯一的请求 ID，以便如果必须重试请求，则服务器会忽略已完成的请求。服务器保证自首次请求起至少 60 分钟内有效。例如，考虑这样一种情况，您发出初始请求并且该请求超时。如果使用相同的请求 ID 再次发出请求，则服务器可以检查是否收到了具有相同请求 ID 的原始操作，如果收到，则忽略第二个请求。这可以防止客户端意外创建重复的提交。请求 ID 必须是有效的 UUID，但不支持零 UUID (00000000-0000-0000-0000-000000000000)。
validate_request (bool) – 可选。如果设置，则执行请求验证，但实际上不执行请求。
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBCreateClusterOperator(cluster_id, cluster_configuration, is_secondary=False, *args, **kwargs)[source]¶
-
创建一个 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][source]¶
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBUpdateClusterOperator(cluster_id, cluster_configuration, update_mask=None, allow_missing=False, *args, **kwargs)[source]¶
-
更新一个 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 所需的帐户链列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的标识必须将“服务帐户令牌创建者”IAM 角色授予紧接的前一个标识，列表中的第一个帐户将此角色授予原始帐户（模板化）。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.alloy_db.AlloyDBDeleteClusterOperator(cluster_id, etag=None, force=False, *args, **kwargs)[source]¶
-
删除一个 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][源代码]¶