pubsub.Message class

代表 Google Cloud Pub/Sub 訊息的介面。

簽名：

export declare class Message<T>

屬性

屬性 修飾符 類型 說明
屬性 { [key: string]: string;} 與訊息一併發布的使用者定義屬性 (如有)。
資料 字串 這個訊息物件的資料酬載，以 Base64 編碼字串表示。
JSON T 這個訊息物件的 JSON 資料酬載 (如有)。
訊息 ID 字串 這是系統自動產生的 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 可序列化表示法。