airflow.providers.google.cloud.hooks.workflows

模組內容

類別

WorkflowsHook

用於 Google GCP API 的 Hook。
class airflow.providers.google.cloud.hooks.workflows.WorkflowsHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

基底類別： airflow.providers.google.common.hooks.base_google.GoogleBaseHook

用於 Google GCP API 的 Hook。

Hook 中所有使用 project_id 的方法都必須使用關鍵字引數而不是位置引數來呼叫。

get_workflows_client()[source]

傳回 WorkflowsClient 物件。

get_executions_client()[source]

傳回 ExecutionsClient 物件。

create_workflow(workflow, workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

建立新的工作流程。

如果具有指定名稱的工作流程已存在於指定的專案和位置中，則長時間執行的操作將傳回 [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]]) – 提供給方法的其他中繼資料。

get_workflow(workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

取得單一工作流程的詳細資訊。

參數

  • 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]]) – 提供給方法的其他中繼資料。

update_workflow(workflow, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

更新現有的工作流程。

執行此方法對已在執行的工作流程執行個體沒有影響。工作流程的新修訂版本可能會因成功的更新操作而建立。在這種情況下，此修訂版本將用於新的工作流程執行個體中。

參數

  • workflow (dict | google.cloud.workflows_v1beta.Workflow) – 必要項目。要建立的工作流程。

  • 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]]) – 提供給方法的其他中繼資料。

delete_workflow(workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

刪除具有指定名稱的工作流程以及所有正在執行的工作流程執行個體。

參數

  • 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]]) – 提供給方法的其他中繼資料。

list_workflows(location, project_id=PROVIDE_PROJECT_ID, filter_=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

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

參數

  • 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]]) – 提供給方法的其他中繼資料。

create_execution(workflow_id, location, execution, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

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

參數

  • 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]]) – 提供給方法的其他中繼資料。

get_execution(workflow_id, execution_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

傳回給定 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]]) – 提供給方法的其他中繼資料。

cancel_execution(workflow_id, execution_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

使用給定 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]]) – 提供給方法的其他中繼資料。

list_executions(workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

傳回屬於具有給定名稱之工作流程的執行個體清單。

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

參數

  • 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]]) – 提供給方法的其他中繼資料。

此條目是否有幫助？