airflow.providers.google.cloud.operators.workflows¶

類¶

`WorkflowsCreateWorkflowOperator`	建立一個新的工作流。
`WorkflowsUpdateWorkflowOperator`	更新現有工作流。
`WorkflowsDeleteWorkflowOperator`	刪除具有指定名稱的工作流及其所有正在執行的執行。
`WorkflowsListWorkflowsOperator`	列出給定專案和位置中的工作流；未指定預設排序順序。
`WorkflowsGetWorkflowOperator`	獲取單個工作流的詳細資訊。
`WorkflowsCreateExecutionOperator`	使用給定工作流的最新版本建立新的執行。
`WorkflowsCancelExecutionOperator`	使用給定的 `workflow_id` 和 `execution_id` 取消執行。
`WorkflowsListExecutionsOperator`	返回屬於給定名稱的工作流的執行列表。
`WorkflowsGetExecutionOperator`	返回給定 `workflow_id` 和 `execution_id` 的執行。

模組內容¶

類 airflow.providers.google.cloud.operators.workflows.WorkflowsCreateWorkflowOperator(*, workflow, workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', force_rerun=False, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

建立一個新的工作流。

如果在指定專案和位置中已存在具有指定名稱的工作流，則長時間執行的操作將返回 [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] 錯誤。

另請參閱

有關如何使用此運算子的更多資訊，請參閱指南：建立工作流

引數:

workflow (dict) – 必需。要建立的工作流。
workflow_id (str) – 必需。要建立的工作流的 ID。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
location (str) – 必需。處理請求的 GCP 區域。
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]]) – 提供給方法的附加元資料。

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

template_fields_renderers[source]¶

operator_extra_links[source]¶

workflow[source]¶

workflow_id[source]¶

location[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

force_rerun = False[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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

類 airflow.providers.google.cloud.operators.workflows.WorkflowsUpdateWorkflowOperator(*, workflow_id, location, project_id=PROVIDE_PROJECT_ID, update_mask=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

更新現有工作流。

執行此方法對工作流已在執行的執行沒有影響。成功的更新操作可能會建立一個新的工作流版本。在這種情況下，新的工作流執行將使用該版本。

另請參閱

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

引數:

workflow_id (str) – 必需。要更新的工作流的 ID。
location (str) – 必需。處理請求的 GCP 區域。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
update_mask (google.protobuf.field_mask_pb2.FieldMask | None) – 要更新的欄位列表。如果不存在，將更新整個工作流。
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]]) – 提供給方法的附加元資料。

template_fields: collections.abc.Sequence[str] = ('workflow_id', 'update_mask')[source]¶

template_fields_renderers[source]¶

operator_extra_links[source]¶

workflow_id[source]¶

location[source]¶

project_id = None[source]¶

update_mask = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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

類 airflow.providers.google.cloud.operators.workflows.WorkflowsDeleteWorkflowOperator(*, workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

刪除具有指定名稱的工作流及其所有正在執行的執行。

另請參閱

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

引數:

workflow_id (str) – 必需。要建立的工作流的 ID。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
location (str) – 必需。處理請求的 GCP 區域。
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]]) – 提供給方法的附加元資料。

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

workflow_id[source]¶

location[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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

類 airflow.providers.google.cloud.operators.workflows.WorkflowsListWorkflowsOperator(*, location, project_id=PROVIDE_PROJECT_ID, filter_=None, order_by=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

列出給定專案和位置中的工作流；未指定預設排序順序。

另請參閱

有關如何使用此運算子的更多資訊，請參閱指南：列出工作流

引數:

filter – 用於將結果限制為特定工作流的過濾器。
order_by (str | None) – 指定結果順序的逗號分隔欄位列表。欄位的預設排序順序是升序。要指定欄位的降序，請附加“desc”字尾。如果未指定，則結果將按未指定的順序返回。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
location (str) – 必需。處理請求的 GCP 區域。
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]]) – 提供給方法的附加元資料。

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

operator_extra_links[source]¶

filter_ = None[source]¶

order_by = None[source]¶

location[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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

類 airflow.providers.google.cloud.operators.workflows.WorkflowsGetWorkflowOperator(*, workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

獲取單個工作流的詳細資訊。

另請參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：獲取工作流

引數:

workflow_id (str) – 必需。要建立的工作流的 ID。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
location (str) – 必需。處理請求的 GCP 區域。
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]]) – 提供給方法的附加元資料。

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

operator_extra_links[source]¶

workflow_id[source]¶

location[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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

類 airflow.providers.google.cloud.operators.workflows.WorkflowsCreateExecutionOperator(*, workflow_id, execution, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

使用給定工作流的最新版本建立新的執行。

另請參閱

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

引數:

execution (字典) – 必需。要建立的執行。
workflow_id (字串) – 必需。工作流的 ID。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
location (str) – 必需。處理請求的 GCP 區域。
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]]) – 提供給方法的附加元資料。

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

template_fields_renderers[source]¶

operator_extra_links[source]¶

workflow_id[source]¶

execution[source]¶

location[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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

類 airflow.providers.google.cloud.operators.workflows.WorkflowsCancelExecutionOperator(*, workflow_id, execution_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

使用給定的 workflow_id 和 execution_id 取消執行。

另請參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：取消執行

引數:

workflow_id (字串) – 必需。工作流的 ID。
execution_id (字串) – 必需。執行的 ID。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
location (str) – 必需。處理請求的 GCP 區域。
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]]) – 提供給方法的附加元資料。

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

operator_extra_links[source]¶

workflow_id[source]¶

execution_id[source]¶

location[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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

類 airflow.providers.google.cloud.operators.workflows.WorkflowsListExecutionsOperator(*, workflow_id, location, start_date_filter=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

返回屬於給定名稱的工作流的執行列表。

此方法返回所有工作流修訂版本的執行。返回的執行按其開始時間排序（最新在前）。

另請參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：列出執行

引數:

workflow_id (str) – 必需。要建立的工作流的 ID。
start_date_filter (datetime.datetime | None) – 如果傳遞此引數，則僅返回早於此日期的執行。預設情況下，Operator 返回最近 60 分鐘內的執行。請注意，datetime 物件必須指定時區，例如 datetime.timezone.utc。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
location (str) – 必需。處理請求的 GCP 區域。
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]]) – 提供給方法的附加元資料。

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

operator_extra_links[source]¶

workflow_id[source]¶

location[source]¶

start_date_filter[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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

類 airflow.providers.google.cloud.operators.workflows.WorkflowsGetExecutionOperator(*, workflow_id, execution_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

返回給定 workflow_id 和 execution_id 的執行。

另請參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：獲取執行

引數:

workflow_id (字串) – 必需。工作流的 ID。
execution_id (字串) – 必需。執行的 ID。
project_id (str) – 必需。工作流所屬的 Google Cloud 專案的 ID。
location (str) – 必需。處理請求的 GCP 區域。
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]]) – 提供給方法的附加元資料。

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

operator_extra_links[source]¶

workflow_id[source]¶

execution_id[source]¶

location[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立運算子時派生。

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

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