airflow.providers.google.cloud.operators.workflows

WorkflowsCreateWorkflowOperator

创建一个新的工作流。

WorkflowsUpdateWorkflowOperator

更新现有工作流。

WorkflowsDeleteWorkflowOperator

删除具有指定名称的工作流及其所有正在运行的执行。

WorkflowsListWorkflowsOperator

列出给定项目和位置中的工作流;未指定默认排序顺序。

WorkflowsGetWorkflowOperator

获取单个工作流的详细信息。

WorkflowsCreateExecutionOperator

使用给定工作流的最新版本创建新的执行。

WorkflowsCancelExecutionOperator

使用给定的 workflow_idexecution_id 取消执行。

WorkflowsListExecutionsOperator

返回属于给定名称的工作流的执行列表。

WorkflowsGetExecutionOperator

返回给定 workflow_idexecution_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]
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]
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]
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]
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]
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_idexecution_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]
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]
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_idexecution_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]
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

此条目有帮助吗?