storage namespace

関数

関数 説明
onObjectArchived(handler) バケットでオブジェクトのバージョニングが有効になっている場合にのみ送信されるイベント ハンドラ。このイベントは、アーカイブ化の操作または同名オブジェクトのアップロードによる上書きが原因で、オブジェクトのライブ バージョンがアーカイブ バージョンになったことを表します。
onObjectarchive(bucket, handler) バケットでオブジェクトのバージョニングが有効になっている場合にのみ送信されるイベント ハンドラ。このイベントは、アーカイブ化の操作または同名オブジェクトのアップロードによる上書きが原因で、オブジェクトのライブ バージョンがアーカイブ バージョンになったことを表します。
onObjectarchive(opts, handler) バケットでオブジェクトのバージョニングが有効になっている場合にのみ送信されるイベント ハンドラ。このイベントは、アーカイブ化の操作または同名オブジェクトのアップロードによる上書きが原因で、オブジェクトのライブ バージョンがアーカイブ バージョンになったことを表します。
onObjectDeleted(handler) Google Cloud Storage の削除が発生するたびに呼び出されるイベント ハンドラ。オブジェクトが完全に削除されたときに送信されます。バケットのライフサイクル構成で上書きまたは削除されたオブジェクトも対象になります。オブジェクトのバージョニングが有効になっているバケットの場合、storage.objects.delete メソッドを介してアーカイブが行われても、オブジェクトがアーカイブされたときにこのメッセージは送信されません。
onObjectDeleted(bucket, handler) 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) 既存のオブジェクトのメタデータが変更されるたびに呼び出されるイベント ハンドラ。

インターフェース

インターフェース 説明
CustomerEncryption ユーザー指定の暗号化キーのメタデータ（オブジェクトがこのようなキーで暗号化されている場合）。
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） =>任意 |<任意> を約束する 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） =>任意 |<任意> を約束する Google Cloud Storage のアーカイブが発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<StorageEvent>

storage.onObjectArchived()

バケットでオブジェクトのバージョニングが有効になっている場合にのみ送信されるイベント ハンドラ。このイベントは、アーカイブ化の操作または同名オブジェクトのアップロードによる上書きが原因で、オブジェクトのライブ バージョンがアーカイブ バージョンになったことを表します。

署名:

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

パラメータ

パラメータ 型 説明
最適化 StorageOptions 個々のイベント処理関数で設定できるオプション。
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>;

パラメータ

パラメータ 型 説明
バケット 文字列 |式<string> このオブジェクトを含むバケット名。
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>;

パラメータ

パラメータ 型 説明
最適化 StorageOptions 個々のイベント処理関数で設定できるオプション。
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>;

パラメータ

パラメータ 型 説明
バケット 文字列 |式<string> このオブジェクトを含むバケット名。
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>;

パラメータ

パラメータ 型 説明
最適化 StorageOptions 個々のイベント処理関数で設定できるオプション。
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>;

パラメータ

パラメータ 型 説明
バケット 文字列 |式<string> このオブジェクトを含むバケット名。
handler （イベント: StorageEvent） =>任意 |<任意> を約束する Google Cloud Storage オブジェクトのメタデータの更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<StorageEvent>

storage.onObjectMetadataUpdated()

既存のオブジェクトのメタデータが変更されるたびに呼び出されるイベント ハンドラ。

署名:

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

パラメータ

パラメータ 型 説明
最適化 StorageOptions 個々のイベント処理関数で設定できるオプション。
handler （イベント: StorageEvent） =>任意 |<任意> を約束する Google Cloud Storage オブジェクトのメタデータの更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<StorageEvent>