airflow.providers.amazon.aws.operators.appflow

模块内容

AppflowBaseOperator

Amazon AppFlow 基础操作符类(不应直接在 DAG 中使用)。

AppflowRunOperator

按原样执行 AppFlow 运行。

AppflowRunFullOperator

执行 AppFlow 完全运行,删除任何筛选器。

AppflowRunBeforeOperator

更新筛选器以仅选择先前数据后执行 AppFlow 运行。

AppflowRunAfterOperator

更新筛选器以仅选择未来数据后执行 AppFlow 运行。

AppflowRunDailyOperator

更新筛选器以仅选择一天后执行 AppFlow 运行。

AppflowRecordsShortCircuitOperator

在 AppFlow 运行为空时短路。

属性

SUPPORTED_SOURCES

MANDATORY_FILTER_DATE_MSG

NOT_SUPPORTED_SOURCE_MSG

airflow.providers.amazon.aws.operators.appflow.SUPPORTED_SOURCES[source]
airflow.providers.amazon.aws.operators.appflow.MANDATORY_FILTER_DATE_MSG = '对于 {entity},filter_date 参数是强制的!'[source]
airflow.providers.amazon.aws.operators.appflow.NOT_SUPPORTED_SOURCE_MSG = '不支持 {entity} 的来源 {source}!'[source]
class airflow.providers.amazon.aws.operators.appflow.AppflowBaseOperator(flow_name, flow_update, source=None, source_field=None, filter_date=None, poll_interval=20, max_attempts=60, wait_for_completion=True, **kwargs)[source]

基类:airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.appflow.AppflowHook]

Amazon AppFlow 基础操作符类(不应直接在 DAG 中使用)。

参数
  • source (str | None) – 源名称(支持:salesforce, zendesk)

  • flow_name (str) – 流名称

  • flow_update (bool) – 一个布尔值,用于在运行之前启用/禁用流更新

  • source_field (str | None) – 应用筛选器的字段名称

  • filter_date (str | None) – 要在筛选器中使用的日期值(或模板)。

  • poll_interval (int) – 以秒为单位检查查询状态的频率

  • max_attempts (int) – 在超时之前检查状态的次数

  • wait_for_completion (bool) – 是否等待运行结束才返回

  • aws_conn_id – 用于 AWS 凭证的 Airflow 连接。如果此值是 None 或空,则使用默认的 boto3 行为。如果以分布式方式运行 Airflow 并且 aws_conn_id 为 None 或空,则将使用默认的 boto3 配置(并且必须在每个工作节点上维护)。

  • region_name – AWS 区域名称。如果未指定,则使用默认的 boto3 行为。

  • verify – 是否验证 SSL 证书。请参阅:https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html

  • botocore_config – botocore 客户端的配置字典(键值对)。请参阅:https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

aws_hook_class[source]
ui_color = '#2bccbd'[source]
template_fields[source]
UPDATE_PROPAGATION_TIME: int = 15[source]
execute(context)[source]

在创建操作符时派生。

上下文与渲染 jinja 模板时使用的字典相同。

请参阅 get_template_context 以了解更多上下文。

class airflow.providers.amazon.aws.operators.appflow.AppflowRunOperator(flow_name, poll_interval=20, wait_for_completion=True, **kwargs)[source]

基类: AppflowBaseOperator

按原样执行 AppFlow 运行。

另请参阅

有关如何使用此操作符的更多信息,请查看指南:运行流完整

参数
  • flow_name (str) – 流名称

  • poll_interval (int) – 以秒为单位检查查询状态的频率

  • aws_conn_id – 用于 AWS 凭证的 Airflow 连接。如果此项为 None 或空,则使用默认的 boto3 行为。如果在分布式环境中运行 Airflow,并且 aws_conn_id 为 None 或空,则将使用默认的 boto3 配置(并且必须在每个工作节点上维护)。

  • region – 要使用的 AWS 区域

  • wait_for_completion (bool) – 是否等待运行结束才返回

class airflow.providers.amazon.aws.operators.appflow.AppflowRunFullOperator(source, flow_name, poll_interval=20, wait_for_completion=True, **kwargs)[source]

基类: AppflowBaseOperator

执行 AppFlow 完全运行,删除任何筛选器。

另请参阅

有关如何使用此操作符的更多信息,请查看指南:运行流每日

参数
  • source (str) – 源名称(支持:salesforce,zendesk)

  • flow_name (str) – 流名称

  • poll_interval (int) – 以秒为单位检查查询状态的频率

  • wait_for_completion (bool) – 是否等待运行结束才返回

class airflow.providers.amazon.aws.operators.appflow.AppflowRunBeforeOperator(source, flow_name, source_field, filter_date, poll_interval=20, wait_for_completion=True, **kwargs)[source]

基类: AppflowBaseOperator

更新筛选器以仅选择先前数据后执行 AppFlow 运行。

另请参阅

有关如何使用此操作符的更多信息,请查看指南:运行流之后

参数
  • source (str) – 源名称(支持:salesforce)

  • flow_name (str) – 流名称

  • source_field (str) – 应用过滤器的字段名称

  • filter_date (str) – 要在过滤器中使用的日期值(或模板)。

  • poll_interval (int) – 以秒为单位检查查询状态的频率

  • aws_conn_id – 用于 AWS 凭证的 Airflow 连接。如果此项为 None 或空,则使用默认的 boto3 行为。如果在分布式环境中运行 Airflow,并且 aws_conn_id 为 None 或空,则将使用默认的 boto3 配置(并且必须在每个工作节点上维护)。

  • region – 要使用的 AWS 区域

  • wait_for_completion (bool) – 是否等待运行结束才返回

class airflow.providers.amazon.aws.operators.appflow.AppflowRunAfterOperator(source, flow_name, source_field, filter_date, poll_interval=20, wait_for_completion=True, **kwargs)[source]

基类: AppflowBaseOperator

更新筛选器以仅选择未来数据后执行 AppFlow 运行。

另请参阅

有关如何使用此操作符的更多信息,请查看指南:跳过空运行的任务

参数
  • source (str) – 源名称(支持:salesforce,zendesk)

  • flow_name (str) – 流名称

  • source_field (str) – 应用过滤器的字段名称

  • filter_date (str) – 要在过滤器中使用的日期值(或模板)。

  • poll_interval (int) – 以秒为单位检查查询状态的频率

  • wait_for_completion (bool) – 是否等待运行结束才返回

class airflow.providers.amazon.aws.operators.appflow.AppflowRunDailyOperator(source, flow_name, source_field, filter_date, poll_interval=20, wait_for_completion=True, **kwargs)[source]

基类: AppflowBaseOperator

更新筛选器以仅选择一天后执行 AppFlow 运行。

另请参阅

有关如何使用此操作符的更多信息,请查看指南:运行流之前

参数
  • source (str) – 源名称(支持:salesforce)

  • flow_name (str) – 流名称

  • source_field (str) – 应用过滤器的字段名称

  • filter_date (str) – 要在过滤器中使用的日期值(或模板)。

  • poll_interval (int) – 以秒为单位检查查询状态的频率

  • wait_for_completion (bool) – 是否等待运行结束才返回

class airflow.providers.amazon.aws.operators.appflow.AppflowRecordsShortCircuitOperator(*, flow_name, appflow_run_task_id, ignore_downstream_trigger_rules=True, aws_conn_id='aws_default', region_name=None, verify=None, botocore_config=None, **kwargs)[source]

基类: airflow.providers.common.compat.standard.operators.ShortCircuitOperator, airflow.providers.amazon.aws.utils.mixins.AwsBaseHookMixin[airflow.providers.amazon.aws.hooks.appflow.AppflowHook]

在 AppFlow 运行为空的情况下进行短路。

另请参阅

有关如何使用此操作符的更多信息,请查看指南:参考

参数
aws_hook_class[source]
template_fields[源代码]
ui_color = '#33ffec'[源代码]

此条目是否有帮助?