storage namespace

函数

函数	说明
onObjectArchived(handler)	仅在存储分区已启用对象版本控制时发送事件处理脚本。此事件表明某个对象的当前版本已变为归档版本，原因可能是该对象已归档，或者已被新上传的同名对象覆盖。
onObjectArchived(存储分区, 处理程序)	仅在存储分区已启用对象版本控制时发送事件处理脚本。此事件表明某个对象的当前版本已变为归档版本，原因可能是该对象已归档，或者已被新上传的同名对象覆盖。
onObjectArchived(优化, 处理程序)	仅在存储分区已启用对象版本控制时发送事件处理脚本。此事件表明某个对象的当前版本已变为归档版本，原因可能是该对象已归档，或者已被新上传的同名对象覆盖。
onObjectDeleted(handler)	每次发生 Google Cloud Storage 删除事件时触发的事件处理脚本。当某个对象被永久删除时发送。这包括在存储分区的生命周期配置过程中被覆盖或删除的对象。对于启用了对象版本控制的存储分区，如果某个对象已归档，则系统不会发送此事件，即使通过 storage.objects.delete 方法进行归档也是如此。
onObjectDeleted(存储分区, 处理程序)	每次发生 Google Cloud Storage 删除事件时触发的事件处理脚本。当某个对象被永久删除时发送。这包括在存储分区的生命周期配置过程中被覆盖或删除的对象。对于启用了对象版本控制的存储分区，如果某个对象已归档，则系统不会发送此事件，即使通过 storage.objects.delete 方法进行归档也是如此。
onObjectDeleted(opts, Handler)	每次发生 Google Cloud Storage 删除事件时触发的事件处理脚本。当某个对象被永久删除时发送。这包括在存储分区的生命周期配置过程中被覆盖或删除的对象。对于启用了对象版本控制的存储分区，如果某个对象已归档，则系统不会发送此事件，即使通过 storage.objects.delete 方法进行归档也是如此。
onObjectFinalized(handler)	每次创建 Google Cloud Storage 对象时触发的事件处理程序。当存储分区中成功创建了新对象（或现有对象的新实例）时发送。这包括复制或重写现有的对象。上传失败不会触发此事件。
onObjectFinalized(bucket, Handler)	每次创建 Google Cloud Storage 对象时触发的事件处理程序。当存储分区中成功创建了新对象（或现有对象的新实例）时发送。这包括复制或重写现有的对象。上传失败不会触发此事件。
onObjectFinalized(opts, Handler)	每次创建 Google Cloud Storage 对象时触发的事件处理程序。当存储分区中成功创建了新对象（或现有对象的新实例）时发送。这包括复制或重写现有的对象。上传失败不会触发此事件。
onObjectMetadataUpdated(handler)	每当现有对象的元数据发生更改时触发的事件处理脚本。
onObjectMetadataUpdated(bucket, Handler)	每当现有对象的元数据发生更改时触发的事件处理脚本。
onObjectMetadataUpdated(opts, Handler)	每当现有对象的元数据发生更改时触发的事件处理脚本。

接口

接口	说明
客户加密	客户提供的加密密钥的元数据（如果对象已使用此类密钥加密）。
StorageEvent	包含 StorageObjectData 的 CloudEvent
StorageObjectData	Google Cloud Storage 中的对象。参考：https://github.com/googleapis/google-cloudevents-nodejs/blob/main/cloud/storage/v1/StorageObjectData.ts
StorageOptions	StorageOptions 使用存储分区名称扩展 EventHandlerOptions

storage.onObjectArchived() 则

仅在存储分区已启用对象版本控制时发送事件处理脚本。此事件表明某个对象的当前版本已变为归档版本，原因可能是该对象已归档，或者已被新上传的同名对象覆盖。

签名：

export declare function onObjectArchived(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 归档时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>

storage.onObjectArchived() 则

仅在存储分区已启用对象版本控制时发送事件处理脚本。此事件表明某个对象的当前版本已变为归档版本，原因可能是该对象已归档，或者已被新上传的同名对象覆盖。

签名：

export declare function onObjectArchived(bucket: string | Expression<string>, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
存储桶	字符串 |表达式<string>	包含此对象的存储分区的名称。
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 归档时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>

storage.onObjectArchived() 则

仅在存储分区已启用对象版本控制时发送事件处理脚本。此事件表明某个对象的当前版本已变为归档版本，原因可能是该对象已归档，或者已被新上传的同名对象覆盖。

签名：

export declare function onObjectArchived(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
优化	StorageOptions	可针对单个事件处理函数设置的选项。
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 归档时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>

storage.onObjectDeleted()

每次发生 Google Cloud Storage 删除事件时触发的事件处理程序。

此事件在对象被永久删除时发送。这包括在存储分区的生命周期配置过程中被覆盖或删除的对象。对于启用了对象版本控制的存储分区，如果某个对象已归档，则系统不会发送此事件，即使通过 storage.objects.delete 方法进行归档也是如此。

签名：

export declare function onObjectDeleted(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 对象删除事件时运行的事件处理脚本。

返回：

CloudFunction<StorageEvent>

storage.onObjectDeleted()

每次发生 Google Cloud Storage 删除事件时触发的事件处理程序。

此事件在对象被永久删除时发送。这包括在存储分区的生命周期配置过程中被覆盖或删除的对象。对于启用了对象版本控制的存储分区，如果某个对象已归档，则系统不会发送此事件，即使通过 storage.objects.delete 方法进行归档也是如此。

签名：

export declare function onObjectDeleted(bucket: string | Expression<string>, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
存储桶	字符串 |表达式<string>	包含此对象的存储分区的名称。
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 对象删除事件时运行的事件处理脚本。

返回：

CloudFunction<StorageEvent>

storage.onObjectDeleted()

每次发生 Google Cloud Storage 删除事件时触发的事件处理程序。

此事件在对象被永久删除时发送。这包括在存储分区的生命周期配置过程中被覆盖或删除的对象。对于启用了对象版本控制的存储分区，如果某个对象已归档，则系统不会发送此事件，即使通过 storage.objects.delete 方法进行归档也是如此。

签名：

export declare function onObjectDeleted(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
优化	StorageOptions	可针对单个事件处理函数设置的选项。
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 对象删除事件时运行的事件处理脚本。

返回：

CloudFunction<StorageEvent>

storage.onObjectFinalized()

每次创建 Google Cloud Storage 对象时触发的事件处理程序。

在存储分区中成功创建了新对象（或现有对象的新实例）时，系统将发送此事件。这包括复制或重写现有的对象。上传失败不会触发此事件。

签名：

export declare function onObjectFinalized(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次创建 Google Cloud Storage 对象时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>

storage.onObjectFinalized()

每次创建 Google Cloud Storage 对象时触发的事件处理程序。

在存储分区中成功创建了新对象（或现有对象的新实例）时，系统将发送此事件。这包括复制或重写现有的对象。上传失败不会触发此事件。

签名：

export declare function onObjectFinalized(bucket: string | Expression<string>, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
存储桶	字符串 |表达式<string>	包含此对象的存储分区的名称。
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次创建 Google Cloud Storage 对象时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>

storage.onObjectFinalized()

每次创建 Google Cloud Storage 对象时触发的事件处理程序。

在存储分区中成功创建了新对象（或现有对象的新实例）时，系统将发送此事件。这包括复制或重写现有的对象。上传失败不会触发此事件。

签名：

export declare function onObjectFinalized(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
优化	StorageOptions	可针对单个事件处理函数设置的选项。
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次创建 Google Cloud Storage 对象时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>

storage.onObjectMetadataUpdated()

每当现有对象的元数据发生更改时触发的事件处理脚本。

签名：

export declare function onObjectMetadataUpdated(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 对象元数据更新时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>

storage.onObjectMetadataUpdated()

每当现有对象的元数据发生更改时触发的事件处理脚本。

签名：

export declare function onObjectMetadataUpdated(bucket: string | Expression<string>, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
存储桶	字符串 |表达式<string>	包含此对象的存储分区的名称。
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 对象元数据更新时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>

storage.onObjectMetadataUpdated()

每当现有对象的元数据发生更改时触发的事件处理脚本。

签名：

export declare function onObjectMetadataUpdated(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

参数

参数	类型	说明
优化	StorageOptions	可针对单个事件处理函数设置的选项。
handler	（事件：StorageEvent）=>任何 |承诺<any>	每次发生 Google Cloud Storage 对象元数据更新时运行的事件处理程序。

返回：

CloudFunction<StorageEvent>