pubsub.Message class

Google Cloud Pub/Sub メッセージを表すインターフェース。

署名:

export declare class Message<T> 

プロパティ

プロパティ	修飾キー	タイプ	説明
属性		{ [キー: 文字列]: 文字列;}	メッセージとともにパブリッシュされるユーザー定義の属性（存在する場合）。
データ		文字列	このメッセージ オブジェクトのデータ ペイロード。base64 でエンコードされた文字列です。
json		T	このメッセージ オブジェクトの JSON データ ペイロード（存在する場合）。
messageId		文字列	このメッセージを一意に識別する自動生成された ID。
orderingKey		文字列	同じキーを持つメッセージ間の順序付けを確保するために使用するユーザー定義のキー。
publishTime		文字列	メッセージが公開された時刻

メソッド

メソッド	修飾キー	説明
toJSON()		このオブジェクトの JSON シリアル化可能な表現を返します。

pubsub.Message.attributes

メッセージとともにパブリッシュされるユーザー定義の属性（存在する場合）。

署名:

readonly attributes: {
        [key: string]: string;
    };

pubsub.Message.data

このメッセージ オブジェクトのデータ ペイロード。base64 でエンコードされた文字列です。

署名:

readonly data: string;

pubsub.Message.json

このメッセージ オブジェクトの JSON データ ペイロード（存在する場合）。

署名:

get json(): T;

pubsub.Message.messageId

このメッセージを一意に識別する自動生成された ID。

署名:

readonly messageId: string;

pubsub.Message.orderingKey

同じキーを持つメッセージ間の順序付けを確保するために使用するユーザー定義のキー。

署名:

readonly orderingKey: string;

pubsub.Message.publishTime

メッセージが公開された時刻

署名:

readonly publishTime: string;

pubsub.Message.toJSON()

このオブジェクトの JSON シリアル化可能な表現を返します。

署名:

toJSON(): any;

戻り値:

任意

このオブジェクトの JSON シリアル化可能な表現。