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]]) – 提供給方法的額外元資料。

此條目有幫助嗎？