storage namespace

函式

函式	說明
onObjectArchive(handler)	只有在值區已啟用物件版本管理功能時，才會傳送事件處理常式。這個事件表示物件的使用中版本已變為封存版本，原因是物件遭到封存或是因為擁有相同名稱的物件上傳而遭到覆寫。
onObjectArchive(值區、處理常式)	只有在值區已啟用物件版本管理功能時，才會傳送事件處理常式。這個事件表示物件的使用中版本已變為封存版本，原因是物件遭到封存或是因為擁有相同名稱的物件上傳而遭到覆寫。
onObjectArchive(最佳化、處理常式)	只有在值區已啟用物件版本管理功能時，才會傳送事件處理常式。這個事件表示物件的使用中版本已變為封存版本，原因是物件遭到封存或是因為擁有相同名稱的物件上傳而遭到覆寫。
onObjectDeleted(handler)	每次發生 Google Cloud Storage 刪除作業時，都會觸發事件處理常式。在物件永久刪除時傳送。值區生命週期設定中覆寫或刪除的物件也包含在內。如果值區已啟用物件版本管理功能，則在封存物件時，系統不會傳送事件，即使透過 storage.objects.delete 方法進行封存也一樣。
onObjectDeleted(bucket, handler)	每次發生 Google Cloud Storage 刪除作業時，都會觸發事件處理常式。在物件永久刪除時傳送。值區生命週期設定中覆寫或刪除的物件也包含在內。如果值區已啟用物件版本管理功能，則在封存物件時，系統不會傳送事件，即使透過 storage.objects.delete 方法進行封存也一樣。
onObjectDeleted(最佳化、處理常式)	每次發生 Google Cloud Storage 刪除作業時，都會觸發事件處理常式。在物件永久刪除時傳送。值區生命週期設定中覆寫或刪除的物件也包含在內。如果值區已啟用物件版本管理功能，則在封存物件時，系統不會傳送事件，即使透過 storage.objects.delete 方法進行封存也一樣。
onObjectFinalized(處理常式)	每次發生 Google Cloud Storage 物件時，就會觸發事件處理常式。在值區中成功建立新物件 (或現有物件的新版本) 時傳送。複製或重寫現有的物件也包含在內。上傳失敗不會觸發這個事件。
onObjectFinalized(值區、處理常式)	每次發生 Google Cloud Storage 物件時，就會觸發事件處理常式。在值區中成功建立新物件 (或現有物件的新版本) 時傳送。複製或重寫現有的物件也包含在內。上傳失敗不會觸發這個事件。
onObjectFinalized(最佳化、處理常式)	每次發生 Google Cloud Storage 物件時，就會觸發事件處理常式。在值區中成功建立新物件 (或現有物件的新版本) 時傳送。複製或重寫現有的物件也包含在內。上傳失敗不會觸發這個事件。
onObjectMetadataUpdated(處理常式)	每次現有物件的中繼資料變更時，觸發的事件處理常式。
onObjectMetadataUpdated(值區, 處理常式)	每次現有物件的中繼資料變更時，觸發的事件處理常式。
onObjectMetadataUpdated(最佳化, 處理常式)	每次現有物件的中繼資料變更時，觸發的事件處理常式。

介面

介面	說明
客戶加密	客戶提供的加密金鑰中繼資料 (如果物件是以這類金鑰加密)。
StorageEvent	包含 StorageObjectData 的 CloudEvent
StorageObjectData	Google Cloud Storage 中的物件。Ref：https://github.com/googleapis/google-cloudevents-nodejs/blob/main/cloud/storage/v1/StorageObjectData.ts
儲存空間選項	StorageOptions 使用值區名稱擴充 EventHandlerOptions

storage.onObjectArchive()

只有在值區已啟用物件版本管理功能時，才會傳送事件處理常式。這個事件表示物件的使用中版本已變為封存版本，原因是物件遭到封存或是因為擁有相同名稱的物件上傳而遭到覆寫。

簽名：

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

參數

參數	類型	說明
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 Google Cloud Storage 封存時都會執行事件處理常式。

傳回：

CloudFunction<StorageEvent>

storage.onObjectArchive()

只有在值區已啟用物件版本管理功能時，才會傳送事件處理常式。這個事件表示物件的使用中版本已變為封存版本，原因是物件遭到封存或是因為擁有相同名稱的物件上傳而遭到覆寫。

簽名：

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

參數

參數	類型	說明
值區	字串 |運算式<字串>	包含此物件的值區名稱。
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 Google Cloud Storage 封存時都會執行事件處理常式。

傳回：

CloudFunction<StorageEvent>

storage.onObjectArchive()

只有在值區已啟用物件版本管理功能時，才會傳送事件處理常式。這個事件表示物件的使用中版本已變為封存版本，原因是物件遭到封存或是因為擁有相同名稱的物件上傳而遭到覆寫。

簽名：

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

參數

參數	類型	說明
最佳化	儲存空間選項	可針對個別事件處理函式設定的選項。
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 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) =>不限 |承諾<任何>	每次發生 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>;

參數

參數	類型	說明
值區	字串 |運算式<字串>	包含此物件的值區名稱。
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 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>;

參數

參數	類型	說明
最佳化	儲存空間選項	可針對個別事件處理函式設定的選項。
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 Google Cloud Storage 物件刪除時，都會執行事件處理常式。

傳回：

CloudFunction<StorageEvent>

storage.onObjectFinalized()

每次發生 Google Cloud Storage 物件時都會觸發的事件處理常式。

當在值區中成功建立新物件 (或現有物件的新版本) 時，會傳送這個事件。其中包含複製或重寫現有的物件。上傳失敗不會觸發這個事件。

簽名：

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

參數

參數	類型	說明
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 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>;

參數

參數	類型	說明
值區	字串 |運算式<字串>	包含此物件的值區名稱。
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 Google Cloud Storage 物件時，都會執行這個事件處理常式。

傳回：

CloudFunction<StorageEvent>

storage.onObjectFinalized()

每次發生 Google Cloud Storage 物件時都會觸發的事件處理常式。

當在值區中成功建立新物件 (或現有物件的新版本) 時，會傳送這個事件。其中包含複製或重寫現有的物件。上傳失敗不會觸發這個事件。

簽名：

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

參數

參數	類型	說明
最佳化	儲存空間選項	可針對個別事件處理函式設定的選項。
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 Google Cloud Storage 物件時，都會執行這個事件處理常式。

傳回：

CloudFunction<StorageEvent>

storage.onObjectMetadataUpdated()

每次現有物件的中繼資料變更時，觸發的事件處理常式。

簽名：

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

參數

參數	類型	說明
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 Google Cloud Storage 物件中繼資料更新時，都會執行這個事件處理常式。

傳回：

CloudFunction<StorageEvent>

storage.onObjectMetadataUpdated()

每次現有物件的中繼資料變更時，觸發的事件處理常式。

簽名：

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

參數

參數	類型	說明
值區	字串 |運算式<字串>	包含此物件的值區名稱。
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 Google Cloud Storage 物件中繼資料更新時，都會執行這個事件處理常式。

傳回：

CloudFunction<StorageEvent>

storage.onObjectMetadataUpdated()

每次現有物件的中繼資料變更時，觸發的事件處理常式。

簽名：

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

參數

參數	類型	說明
最佳化	儲存空間選項	可針對個別事件處理函式設定的選項。
handler	(事件：StorageEvent) =>不限 |承諾<任何>	每次發生 Google Cloud Storage 物件中繼資料更新時，都會執行這個事件處理常式。

傳回：

CloudFunction<StorageEvent>