pubsub.Message class

表示 Google Cloud Pub/Sub 消息的界面。

签名

export declare class Message<T> 

属性

属性 修饰符 类型 说明
属性 { [键: 字符串]: 字符串;} 通过消息发布的用户定义的属性(如果有)。
数据 字符串 此消息对象的数据载荷,以 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 表示法。