storage.ObjectBuilder class

Google Cloud Storage オブジェクト ビルダーのインターフェース

functions.storage.object() でアクセス。

署名:

export declare class ObjectBuilder 

メソッド

メソッド 修飾キー 説明
onArchive(handler) バケットでオブジェクトのバージョニングが有効になっている場合にのみ送信されるイベント ハンドラ。このイベントは、アーカイブ化の操作または同名オブジェクトのアップロードによる上書きが原因で、オブジェクトのライブ バージョンがアーカイブ バージョンになったことを表します。
onDelete(handler) Google Cloud Storage の削除が発生するたびに呼び出されるイベント ハンドラ。オブジェクトが完全に削除されたときに送信されます。バケットのライフサイクル構成で上書きまたは削除されたオブジェクトも対象になります。オブジェクトのバージョニングが有効になっているバケットの場合、storage.objects.delete メソッドを介してアーカイブが行われても、オブジェクトがアーカイブされたときにこのメッセージは送信されません。
onFinalize(handler) Google Cloud Storage オブジェクトが作成されるたびに呼び出されるイベント ハンドラ。バケット内で新しいオブジェクト(または既存のオブジェクトの新しい世代)が正常に作成されたときに送信されます。既存のオブジェクトのコピーまたは書き換えを行った場合にも送信されます。アップロードが失敗した場合、このイベントはトリガーされません。
onMetadataUpdate(handler) 既存のオブジェクトのメタデータが変更されるたびに呼び出されるイベント ハンドラ。

storage.ObjectBuilder.onArchive()

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

署名:

onArchive(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any): CloudFunction<ObjectMetadata>;

パラメータ

パラメータ 説明
handler (オブジェクト: ObjectMetadata、コンテキスト: EventContext)=>PromiseLike<any>|すべて Google Cloud Storage のアーカイブが発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<ObjectMetadata>

エクスポートしてデプロイできる関数。

storage.ObjectBuilder.onDelete()

Google Cloud Storage の削除が発生するたびに呼び出されるイベント ハンドラ。

オブジェクトが完全に削除された場合に送信されます。バケットのライフサイクル構成で上書きまたは削除されたオブジェクトも対象になります。オブジェクトのバージョニングが有効になっているバケットの場合、storage.objects.delete メソッドを介してアーカイブが行われても、オブジェクトがアーカイブされたときにこのメッセージは送信されません。

署名:

onDelete(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any): CloudFunction<ObjectMetadata>;

パラメータ

パラメータ 説明
handler (オブジェクト: ObjectMetadata、コンテキスト: EventContext)=>PromiseLike<any>|すべて Google Cloud Storage の削除が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<ObjectMetadata>

エクスポートしてデプロイできる関数。

storage.ObjectBuilder.onFinalize()

Google Cloud Storage オブジェクトの作成ごとに呼び出されるイベント ハンドラ。

バケットで新しいオブジェクト(または既存オブジェクトの新しい世代)が正常に作成された場合に送信されます。既存のオブジェクトをコピーまたは再作成した場合にも送信されます。アップロードが失敗した場合、このイベントはトリガーされません。

署名:

onFinalize(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any): CloudFunction<ObjectMetadata>;

パラメータ

パラメータ 説明
handler (オブジェクト: ObjectMetadata、コンテキスト: EventContext)=>PromiseLike<any>|すべて Google Cloud Storage オブジェクトが作成されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<ObjectMetadata>

エクスポートしてデプロイできる関数。

storage.ObjectBuilder.onMetadataUpdate()

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

署名:

onMetadataUpdate(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any): CloudFunction<ObjectMetadata>;

パラメータ

パラメータ 説明
handler (オブジェクト: ObjectMetadata、コンテキスト: EventContext)=>PromiseLike<any>|すべて Google Cloud Storage メタデータの更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<ObjectMetadata>

エクスポートしてデプロイできる関数。