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

模組內容¶

類別¶

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

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

繼承自 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]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

繼承自 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]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

繼承自 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]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

繼承自 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]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

繼承自 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]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

繼承自 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

使用給定工作流程的最新修訂版本建立新的執行個體。

另請參閱

有關如何使用此運算子的更多資訊，請參閱指南：建立執行個體

參數

execution (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_id', 'execution')[source]¶

template_fields_renderers[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

繼承自 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

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

另請參閱

有關如何使用此運算子的更多資訊，請參閱指南：取消執行個體

參數

workflow_id (str) – 必填。工作流程的 ID。
execution_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', 'execution_id')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

繼承自 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

傳回屬於具有指定名稱的工作流程的執行個體列表。

此方法會傳回所有工作流程修訂版本的執行個體。傳回的執行個體會依其開始時間排序（最新的在最前面）。

另請參閱

如需關於如何使用此運算子的更多資訊，請參閱指南：列出執行個體

參數

workflow_id (str) – 必填。要建立的工作流程 ID。
start_date_filter (datetime.datetime | None) – 若有傳入，則只會傳回比此日期舊的執行個體。預設情況下，運算子會傳回過去 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]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

繼承自 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

傳回給定 workflow_id 和 execution_id 的執行個體。

另請參閱

如需關於如何使用此運算子的更多資訊，請參閱指南：取得執行個體

參數

workflow_id (str) – 必填。工作流程的 ID。
execution_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', 'execution_id')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

上下文與渲染 Jinja 模板時使用的字典相同。

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

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

模組內容¶

類別¶

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