airflow.providers.google.cloud.operators.managed_kafka¶
此模块包含 Apache Kafka 托管服务的 Operator。
类¶
Managed Kafka Operator 的基类。 |
|
创建一个新的 Apache Kafka 集群。 |
|
列出给定项目和位置中的集群。 |
|
获取一个 Apache Kafka 集群。 |
|
更新单个集群的属性。 |
|
删除一个 Apache Kafka 集群。 |
|
在给定项目和位置中创建一个新的 Topic。 |
|
列出给定集群中的 Topic。 |
|
返回单个 Topic 的属性。 |
|
更新单个 Topic 的属性。 |
|
删除单个 Topic。 |
|
列出给定集群中的 Consumer Group。 |
|
返回单个 Consumer Group 的属性。 |
|
更新单个 Consumer Group 的属性。 |
|
删除单个 Consumer Group。 |
模块内容¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaBaseOperator(project_id, location, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
Managed Kafka Operator 的基类。
- 参数:
project_id (str) – 必需。服务所属的 Google Cloud 项目 ID。
location (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]]) – 应与请求一起作为元数据发送的字符串。
gcp_conn_id (str) – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'gcp_conn_id', 'project_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaCreateClusterOperator(cluster, cluster_id, request_id=None, *args, **kwargs)[source]¶
-
创建一个新的 Apache Kafka 集群。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster (google.cloud.managedkafka_v1.types.Cluster | dict) – 必需。要创建的集群配置。其
name
字段将被忽略。cluster_id (str) – 必需。用于集群的 ID,它将成为集群名称的最后一个组成部分。ID 必须长 1-63 个字符,并匹配正则表达式
[a-z]([-a-z0-9]*[a-z0-9])?
以符合 RFC 1035。该值结构如下:my-cluster-id
。request_id (str | None) – 可选。可选的请求 ID,用于标识请求。指定唯一的请求 ID 可避免请求重复。如果请求超时或失败,使用相同的 ID 重试可让服务器识别先前的尝试。在至少 60 分钟内,服务器会忽略带有相同 ID 的重复请求。例如,假设您发起一个初始请求并且该请求超时。如果在最后一次请求后的 60 分钟内,您使用相同的请求 ID 再次发起请求,服务器会检查是否收到了带有相同请求 ID 的原始操作。如果是,则服务器会忽略第二个请求。请求 ID 必须是有效的 UUID。不支持零 UUID (00000000-0000-0000-0000-000000000000)。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaListClustersOperator(page_size=None, page_token=None, filter=None, order_by=None, *args, **kwargs)[source]¶
-
列出给定项目和位置中的集群。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
page_size (int | None) – 可选。要返回的最大集群数量。服务可能返回少于此值。如果未指定,服务器将选择一个合适的默认值。
page_token (str | None) – 可选。页面令牌,从之前的
ListClusters
调用中接收。提供此令牌以检索后续页面。在分页时,提供给ListClusters
的所有其他参数必须与提供页面令牌的调用匹配。filter (str | None) – 可选。结果的过滤表达式。
order_by (str | None) – 可选。结果的排序字段。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaGetClusterOperator(cluster_id, *args, **kwargs)[source]¶
-
获取一个 Apache Kafka 集群。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要返回配置的集群 ID。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaUpdateClusterOperator(cluster_id, cluster, update_mask, request_id=None, *args, **kwargs)[source]¶
-
更新单个集群的属性。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要更新配置的集群 ID。
cluster (google.cloud.managedkafka_v1.types.Cluster | dict) – 必需。要更新的集群。
update_mask (google.protobuf.field_mask_pb2.FieldMask | dict) – 必需。字段掩码用于指定更新时要在集群资源中覆盖的字段。update_mask 中指定的字段是相对于资源而言的,而不是完整的请求。如果字段在掩码中,则会被覆盖。
request_id (str | None) – 可选。可选的请求 ID,用于标识请求。指定唯一的请求 ID 可避免请求重复。如果请求超时或失败,使用相同的 ID 重试可让服务器识别先前的尝试。在至少 60 分钟内,服务器会忽略带有相同 ID 的重复请求。例如,假设您发起一个初始请求并且该请求超时。如果在最后一次请求后的 60 分钟内,您使用相同的请求 ID 再次发起请求,服务器会检查是否收到了带有相同请求 ID 的原始操作。如果是,则服务器会忽略第二个请求。请求 ID 必须是有效的 UUID。不支持零 UUID (00000000-0000-0000-0000-000000000000)。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaDeleteClusterOperator(cluster_id, request_id=None, *args, **kwargs)[source]¶
-
删除一个 Apache Kafka 集群。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要删除的集群的 ID。
request_id (str | None) – 可选。可选的请求 ID,用于标识请求。指定唯一的请求 ID 可避免请求重复。如果请求超时或失败,使用相同的 ID 重试可让服务器识别先前的尝试。在至少 60 分钟内,服务器会忽略带有相同 ID 的重复请求。例如,假设您发起一个初始请求并且该请求超时。如果在最后一次请求后的 60 分钟内,您使用相同的请求 ID 再次发起请求,服务器会检查是否收到了带有相同请求 ID 的原始操作。如果是,则服务器会忽略第二个请求。请求 ID 必须是有效的 UUID。不支持零 UUID (00000000-0000-0000-0000-000000000000)。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaCreateTopicOperator(cluster_id, topic_id, topic, *args, **kwargs)[source]¶
-
在给定项目和位置中创建一个新的 Topic。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要在其中创建主题的集群的 ID。
topic_id (str) – 必需。用于主题的 ID,它将成为主题名称的最终组成部分。
topic (google.cloud.managedkafka_v1.types.Topic | dict) – 必需。要创建的主题配置。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaListTopicsOperator(cluster_id, page_size=None, page_token=None, *args, **kwargs)[source]¶
-
列出给定集群中的 Topic。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要列出其主题的集群的 ID。
page_size (int | None) – 可选。要返回的主题的最大数量。服务返回的主题数量可能少于此值。如果未设置或为零,则返回父资源的所有主题。
page_token (str | None) – 可选。从先前的
ListTopics
调用收到的分页令牌。提供此令牌可检索后续页面。分页时,提供给ListTopics
的所有其他参数必须与提供分页令牌的调用匹配。retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaGetTopicOperator(cluster_id, topic_id, *args, **kwargs)[source]¶
-
返回单个 Topic 的属性。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要返回其主题的集群的 ID。
topic_id (str) – 必需。要返回其配置的主题的 ID。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaUpdateTopicOperator(cluster_id, topic_id, topic, update_mask, *args, **kwargs)[source]¶
-
更新单个 Topic 的属性。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要更新其主题的集群的 ID。
topic_id (str) – 必需。要更新其配置的主题的 ID。
topic (google.cloud.managedkafka_v1.types.Topic | dict) – 必需。要更新的主题。必须填充其
name
字段。update_mask (google.protobuf.field_mask_pb2.FieldMask | dict) – 必需。字段掩码用于指定要通过更新覆盖主题资源中的哪些字段。update_mask 中指定的字段是相对于资源而言的,而不是相对于完整请求。如果在掩码中指定了某个字段,则该字段将被覆盖。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaDeleteTopicOperator(cluster_id, topic_id, *args, **kwargs)[source]¶
-
删除单个 Topic。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要删除其主题的集群的 ID。
topic_id (str) – 必需。要删除的主题的 ID。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaListConsumerGroupsOperator(cluster_id, page_size=None, page_token=None, *args, **kwargs)[source]¶
-
列出给定集群中的 Consumer Group。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要列出其消费者组的集群的 ID。
page_size (int | None) – 可选。要返回的消费者组的最大数量。服务返回的消费者组数量可能少于此值。如果未设置或为零,则返回父资源的所有消费者组。
page_token (str | None) – 可选。从先前的
ListConsumerGroups
调用收到的分页令牌。提供此令牌可检索后续页面。分页时,提供给ListConsumerGroups
的所有其他参数必须与提供分页令牌的调用匹配。retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaGetConsumerGroupOperator(cluster_id, consumer_group_id, *args, **kwargs)[source]¶
-
返回单个 Consumer Group 的属性。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要返回其消费者组的集群的 ID。
consumer_group_id (str) – 必需。要返回其配置的消费者组的 ID。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaUpdateConsumerGroupOperator(cluster_id, consumer_group_id, consumer_group, update_mask, *args, **kwargs)[source]¶
-
更新单个 Consumer Group 的属性。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要更新其主题的集群的 ID。
consumer_group_id (str) – 必需。要更新其配置的使用者组的 ID。
consumer_group (google.cloud.managedkafka_v1.types.Topic | dict) – 必需。要更新的使用者组。其
name
字段必须填写。update_mask (google.protobuf.field_mask_pb2.FieldMask | dict) – 必需。字段掩码用于指定在更新操作中要覆盖 ConsumerGroup 资源中的哪些字段。update_mask 中指定的字段是相对于资源本身,而不是整个请求。如果字段在掩码中,则会被覆盖。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶
- class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaDeleteConsumerGroupOperator(cluster_id, consumer_group_id, *args, **kwargs)[source]¶
-
删除单个 Consumer Group。
- 参数:
project_id – 必需。服务所属的 Google Cloud 项目 ID。
location – 必需。服务所属的 Google Cloud 区域 ID。
cluster_id (str) – 必需。要删除其使用者组的集群的 ID。
consumer_group_id (str) – 必需。要删除的使用者组的 ID。
retry – 指定应重试哪些错误(如果有)。
timeout – 此请求的超时时间。
metadata – 应与请求一起作为元数据发送的字符串。
gcp_conn_id – 连接到 Google Cloud 时使用的连接 ID。
impersonation_chain – 可选的服务账号,用于使用短期凭据进行模拟,或者获取列表中最后一个账号的 access_token 所需的账号链,该账号链将在请求中被模拟。如果设置为字符串,则此账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予其紧前身份,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str][source]¶