• 主页
• airflow.providers.google
• airflow.providers.google.cloud
• airflow.providers.google.cloud.operators
• airflow.providers.google.cloud.operators.functions

airflow.providers.google.cloud.operators.functions

此模块包含 Google Cloud Functions 操作符。

属性

CLOUD_FUNCTION_VALIDATION
GCF_SOURCE_ARCHIVE_URL
GCF_SOURCE_UPLOAD_URL
SOURCE_REPOSITORY
GCF_ZIP_PATH
FUNCTION_NAME_PATTERN
FUNCTION_NAME_COMPILED_PATTERN

类

CloudFunctionDeployFunctionOperator	在 Google Cloud Functions 中创建或更新函数。
ZipPathPreprocessor	预处理 zip_path 参数。
CloudFunctionDeleteFunctionOperator	从 Google Cloud Functions 删除指定的函数。
CloudFunctionInvokeFunctionOperator	调用已部署的 Cloud Function。由于允许的流量非常有限，此操作符用于测试目的。

模块内容

airflow.providers.google.cloud.operators.functions.CLOUD_FUNCTION_VALIDATION: list[dict[str, Any]]

class airflow.providers.google.cloud.operators.functions.CloudFunctionDeployFunctionOperator(*, location, body, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', api_version='v1', zip_path=None, validate_body=True, impersonation_chain=None, **kwargs)

基类: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

在 Google Cloud Functions 中创建或更新函数。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南：CloudFunctionDeployFunctionOperator

参数:

• location (str) – 应创建函数的 Google Cloud 区域。

• body (dict) – Cloud Functions 定义的主体。主体必须是 Cloud Functions 字典，如以下链接中所述：https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions。不同的 API 版本需要不同变体的 Cloud Functions 字典。

• project_id (str) – (可选) 应创建函数的 Google Cloud 项目 ID。

• gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。默认为 'google_cloud_default'。

• api_version (str) – (可选) 使用的 API 版本 (例如 v1 - 默认 - 或 v1beta1)。

• zip_path (str | None) – 包含函数源代码的 zip 文件的路径。如果设置了此路径，则不应在主体中指定或应为空 sourceUploadUrl。然后将使用 Cloud Functions API 中 generateUploadUrl 生成的上传 URL 上传 zip 文件。

• validate_body (bool) – 如果设置为 False，则不执行主体验证。

• impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭证进行模拟，或者用于获取列表中最后一个账号的 access_token 的链式账号列表，最后一个账号将在请求中被模拟。如果设置为字符串，该账号必须授予原始账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须向紧邻的前一个身份授予 Service Account Token Creator IAM 角色，列表中的第一个账号将此角色授予原始账号（模板化）。

template_fields: collections.abc.Sequence[str] = ('body', 'project_id', 'location', 'gcp_conn_id', 'api_version', 'impersonation_chain')

operator_extra_links

project_id = None

location

body

gcp_conn_id = 'google_cloud_default'

api_version = 'v1'

zip_path = None

zip_path_preprocessor

impersonation_chain = None

execute(context)

在创建操作符时派生此方法。

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

有关更多上下文，请参考 get_template_context。

airflow.providers.google.cloud.operators.functions.GCF_SOURCE_ARCHIVE_URL = 'sourceArchiveUrl'

airflow.providers.google.cloud.operators.functions.GCF_SOURCE_UPLOAD_URL = 'sourceUploadUrl'

airflow.providers.google.cloud.operators.functions.SOURCE_REPOSITORY = 'sourceRepository'

airflow.providers.google.cloud.operators.functions.GCF_ZIP_PATH = 'zip_path'

class airflow.providers.google.cloud.operators.functions.ZipPathPreprocessor(body, zip_path=None)

预处理 zip_path 参数。

负责检查 zip_path 参数与 source_code 主体字段是否正确指定。非空的 zip_path 参数很特别，因为它与 sourceArchiveUrl 和 sourceRepository 主体字段互斥。它也与非空的 sourceUploadUrl 互斥。当 zip_path 非空时，预处理会以特殊方式修改 sourceUploadUrl 主体字段。当调用 execute 方法并且 sourceUploadUrl 字段值在主体中设置为 generateUploadUrl Cloud Function API 方法返回的值时，会运行一个额外步骤。

参数:

• body (dict) – 传递给 create/update 方法调用的主体。

• zip_path (str | None) – (可选) 包含函数源代码的 zip 文件的路径。如果设置了此路径，则不应在主体中指定或应为空 sourceUploadUrl。然后将使用 Cloud Functions API 中 generateUploadUrl 生成的上传 URL 上传 zip 文件。

upload_function: bool | None = None

body

zip_path = None

should_upload_function()

检查是否应上传函数源代码。

preprocess_body()

当 zip_path 非空时，以特殊方式修改 sourceUploadUrl 主体字段。

airflow.providers.google.cloud.operators.functions.FUNCTION_NAME_PATTERN = '^projects/[^/]+/locations/[^/]+/functions/[^/]+$'

airflow.providers.google.cloud.operators.functions.FUNCTION_NAME_COMPILED_PATTERN

class airflow.providers.google.cloud.operators.functions.CloudFunctionDeleteFunctionOperator(*, name, gcp_conn_id='google_cloud_default', api_version='v1', impersonation_chain=None, project_id=PROVIDE_PROJECT_ID, **kwargs)

基类: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

从 Google Cloud Functions 删除指定的函数。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南：CloudFunctionDeleteFunctionOperator

参数:

• name (str) – 符合以下模式的完全限定函数名称：^projects/[^/]+/locations/[^/]+/functions/[^/]+$

• gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。

• api_version (str) – 使用的 API 版本（例如 v1 或 v1beta1）。

• impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭证进行模拟，或者用于获取列表中最后一个账号的 access_token 的链式账号列表，最后一个账号将在请求中被模拟。如果设置为字符串，该账号必须授予原始账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须向紧邻的前一个身份授予 Service Account Token Creator IAM 角色，列表中的第一个账号将此角色授予原始账号（模板化）。

template_fields: collections.abc.Sequence[str] = ('name', 'gcp_conn_id', 'api_version', 'impersonation_chain')

operator_extra_links

name

project_id = None

gcp_conn_id = 'google_cloud_default'

api_version = 'v1'

impersonation_chain = None

execute(context)

在创建操作符时派生此方法。

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

有关更多上下文，请参考 get_template_context。

class airflow.providers.google.cloud.operators.functions.CloudFunctionInvokeFunctionOperator(*, function_id, input_data, location, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', api_version='v1', impersonation_chain=None, **kwargs)

基类: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

调用已部署的 Cloud Function。由于允许的流量非常有限，此操作符用于测试目的。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南：CloudFunctionDeployFunctionOperator

参数:

• function_id (str) – 要调用的函数 ID

• input_data (dict) – 传递给函数的输入数据

• location (str) – 函数所在的区域。

• project_id (str) – 可选，函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭证进行模拟，或者用于获取列表中最后一个账号的 access_token 的链式账号列表，最后一个账号将在请求中被模拟。如果设置为字符串，该账号必须授予原始账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须向紧邻的前一个身份授予 Service Account Token Creator IAM 角色，列表中的第一个账号将此角色授予原始账号（模板化）。

返回:

None

template_fields: collections.abc.Sequence[str] = ('function_id', 'input_data', 'location', 'project_id', 'impersonation_chain')

operator_extra_links

function_id

input_data

location

project_id = None

gcp_conn_id = 'google_cloud_default'

api_version = 'v1'

impersonation_chain = None

execute(context)

在创建操作符时派生此方法。

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

有关更多上下文，请参考 get_template_context。

上一页 下一页

此条目是否有帮助？