pubsub.Message class

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

署名:

export declare class Message 

コンストラクタ

コンストラクタ 修飾キー 説明
(コンストラクタ)(データ) Message クラスの新しいインスタンスを作成します。

プロパティ

プロパティ 修飾キー タイプ 説明
属性 { [キー: 文字列]: 文字列;} メッセージとともにパブリッシュされるユーザー定義の属性(存在する場合)。
データ 文字列 このメッセージ オブジェクトのデータ ペイロード。base64 でエンコードされた文字列です。
json 任意 このメッセージ オブジェクトの JSON データ ペイロード(存在する場合)。

メソッド

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

pubsub.Message.(コンストラクタ)

Message クラスの新しいインスタンスを作成します。

署名:

constructor(data: any);

パラメータ

パラメータ 説明
データ 任意

pubsub.Message.attributes

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

署名:

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

pubsub.Message.data

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

署名:

readonly data: string;

pubsub.Message.json

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

署名:

get json(): any;

pubsub.Message.toJSON()

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

署名:

toJSON(): any;

戻り値:

任意

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