airflow.providers.google.cloud.transfers.gcs_to_local¶
模块内容¶
类¶
从 Google Cloud Storage 下载文件。 |
- class airflow.providers.google.cloud.transfers.gcs_to_local.GCSToLocalFilesystemOperator(*, bucket, object_name, filename=None, store_to_xcom_key=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, file_encoding='utf-8', **kwargs)[源代码]¶
基类：
airflow.models.BaseOperator从 Google Cloud Storage 下载文件。
如果提供了文件名，它会将文件写入指定位置，或者可以设置
store_to_xcom_key参数为 True，将文件内容推送到 xcom。当文件大小超过 xcom 的最大大小时，建议写入文件。参见
有关如何使用此操作符的更多信息，请查看指南：GCSToLocalFilesystemOperator
- 参数
bucket (str) – 对象所在的 Google Cloud Storage 存储桶。不得包含 ‘gs://’ 前缀。（已模板化）
object_name (str) – 要在 Google Cloud Storage 存储桶中下载的对象的名称。（已模板化）
filename (str | None) – 本地文件系统（执行操作符的位置）上的文件路径，包括文件名，文件应下载到该位置。（已模板化）如果未传递文件名，则下载的数据将不会存储在本地文件系统中。
store_to_xcom_key (str | None) – 如果设置此参数，操作符会将下载文件的内容推送到 XCom，并将此参数中设置的键作为 XCom 的键。如果未设置，下载的数据将不会推送到 XCom。（已模板化）
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选服务帐户，用于使用短期凭据进行模拟，或用于获取列表中最后一个帐户的 access_token 的链接帐户列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予原始帐户 Service Account Token Creator IAM 角色。如果设置为序列，则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧接的前一个身份，列表中的第一个帐户将此角色授予原始帐户（已模板化）。
file_encoding (str) – 可选编码，用于将 file_bytes 解码为适合存储到 XCom 的可序列化字符串。（已模板化）。
- template_fields: collections.abc.Sequence[str] = ('bucket', 'object_name', 'filename', 'store_to_xcom_key', 'impersonation_chain', 'file_encoding')[源代码]¶