airflow.providers.google.cloud.operators.managed_kafka¶

此模組包含 Apache Kafka 託管服務的 Operator。

類¶

`ManagedKafkaBaseOperator`	Managed Kafka Operator 的基類。
`ManagedKafkaCreateClusterOperator`	建立一個新的 Apache Kafka 叢集。
`ManagedKafkaListClustersOperator`	列出給定專案和位置中的叢集。
`ManagedKafkaGetClusterOperator`	獲取一個 Apache Kafka 叢集。
`ManagedKafkaUpdateClusterOperator`	更新單個叢集的屬性。
`ManagedKafkaDeleteClusterOperator`	刪除一個 Apache Kafka 叢集。
`ManagedKafkaCreateTopicOperator`	在給定專案和位置中建立一個新的 Topic。
`ManagedKafkaListTopicsOperator`	列出給定叢集中的 Topic。
`ManagedKafkaGetTopicOperator`	返回單個 Topic 的屬性。
`ManagedKafkaUpdateTopicOperator`	更新單個 Topic 的屬性。
`ManagedKafkaDeleteTopicOperator`	刪除單個 Topic。
`ManagedKafkaListConsumerGroupsOperator`	列出給定叢集中的 Consumer Group。
`ManagedKafkaGetConsumerGroupOperator`	返回單個 Consumer Group 的屬性。
`ManagedKafkaUpdateConsumerGroupOperator`	更新單個 Consumer Group 的屬性。
`ManagedKafkaDeleteConsumerGroupOperator`	刪除單個 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]¶

location[source]¶

project_id[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

property hook: airflow.providers.google.cloud.hooks.managed_kafka.ManagedKafkaHook[source]¶

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaCreateClusterOperator(cluster, cluster_id, request_id=None, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

建立一個新的 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]¶

operator_extra_links[source]¶

cluster[source]¶

cluster_id[source]¶

request_id = None[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaListClustersOperator(page_size=None, page_token=None, filter=None, order_by=None, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

列出給定專案和位置中的叢集。

引數:

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]¶

operator_extra_links[source]¶

page_size = None[source]¶

page_token = None[source]¶

filter = None[source]¶

order_by = None[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaGetClusterOperator(cluster_id, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

獲取一個 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]¶

operator_extra_links[source]¶

cluster_id[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaUpdateClusterOperator(cluster_id, cluster, update_mask, request_id=None, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

更新單個叢集的屬性。

引數:

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]¶

operator_extra_links[source]¶

cluster_id[source]¶

cluster[source]¶

update_mask[source]¶

request_id = None[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaDeleteClusterOperator(cluster_id, request_id=None, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

刪除一個 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]¶

cluster_id[source]¶

request_id = None[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaCreateTopicOperator(cluster_id, topic_id, topic, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

在給定專案和位置中建立一個新的 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]¶

operator_extra_links[source]¶

cluster_id[source]¶

topic_id[source]¶

topic[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaListTopicsOperator(cluster_id, page_size=None, page_token=None, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

列出給定叢集中的 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]¶

operator_extra_links[source]¶

cluster_id[source]¶

page_size = None[source]¶

page_token = None[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaGetTopicOperator(cluster_id, topic_id, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

返回單個 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]¶

operator_extra_links[source]¶

cluster_id[source]¶

topic_id[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaUpdateTopicOperator(cluster_id, topic_id, topic, update_mask, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

更新單個 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]¶

operator_extra_links[source]¶

cluster_id[source]¶

topic_id[source]¶

topic[source]¶

update_mask[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaDeleteTopicOperator(cluster_id, topic_id, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

刪除單個 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]¶

cluster_id[source]¶

topic_id[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaListConsumerGroupsOperator(cluster_id, page_size=None, page_token=None, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

列出給定叢集中的 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]¶

operator_extra_links[source]¶

cluster_id[source]¶

page_size = None[source]¶

page_token = None[source]¶

execute(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaGetConsumerGroupOperator(cluster_id, consumer_group_id, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

返回單個 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]¶

operator_extra_links[source]¶

cluster_id[source]¶

consumer_group_id[source]¶

執行(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaUpdateConsumerGroupOperator(cluster_id, consumer_group_id, consumer_group, update_mask, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

更新單個 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]¶

operator_extra_links[source]¶

cluster_id[source]¶

consumer_group_id[source]¶

consumer_group[source]¶

update_mask[source]¶

執行(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。

class airflow.providers.google.cloud.operators.managed_kafka.ManagedKafkaDeleteConsumerGroupOperator(cluster_id, consumer_group_id, *args, **kwargs)[source]¶

基類: ManagedKafkaBaseOperator

刪除單個 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]¶

cluster_id[source]¶

consumer_group_id[source]¶

執行(context)[source]¶

在建立 Operator 時派生。

Context 是與渲染 Jinja 模板時使用的字典相同。

請參閱 get_template_context 以獲取更多 Context 資訊。