CloudEvent interface

CloudEvent 描述事件数据。

签名

export interface CloudEvent 

属性

属性 类型 说明
数据 对象 |字符串 事件的数据载荷。对象通过 JSON 进行字符串化,而字符串将按原样传递。
datacontenttype 字符串 data 字段中的事件一起发送的数据的 MIME 类型。目前仅支持 application/jsontext/plain。如果未指定,系统会自动根据所提供数据的类型推断得出。
id 字符串 事件的标识符。如果未提供,系统会使用 UUID 自动填充它。
source 字符串 标识事件发生的上下文。如果未提供此值,系统会使用 EVENTARC_CLOUD_EVENT_SOURCE 环境变量的值;如果未设置该值,系统会抛出验证错误。
specversion CloudEventVersion 事件使用的 CloudEvents 规范的版本。如果未提供,则设置为 1.0 - 唯一支持的值。
主题 字符串 事件提供方上下文中事件的主题(上下文)。
时间 字符串 事件的时间戳。必须采用 ISO 时间格式。如果未指定,则系统会使用发布时的当前时间。
type 字符串 事件的类型。应带有反向 DNS 名称 (com.my-org.v1.something.happended) 前缀。

CloudEvent.data

事件的数据载荷。对象通过 JSON 进行字符串化,而字符串将按原样传递。

签名

data?: object | string;

CloudEvent.datacontenttype

data 字段中的事件一起发送的数据的 MIME 类型。目前仅支持 application/jsontext/plain。如果未指定,系统会自动根据所提供数据的类型推断得出。

签名

datacontenttype?: string;

CloudEvent.id

事件的标识符。如果未提供,系统会使用 UUID 自动填充它。

签名

id?: string;

CloudEvent.source

标识事件发生的上下文。如果未提供此值,系统会使用 EVENTARC_CLOUD_EVENT_SOURCE 环境变量的值;如果未设置该值,系统会抛出验证错误。

签名

source?: string;

CloudEvent.specversion

事件使用的 CloudEvents 规范的版本。如果未提供,则设置为 1.0 - 唯一支持的值。

签名

specversion?: CloudEventVersion;

CloudEvent.subject

事件提供方上下文中事件的主题(上下文)。

签名

subject?: string;

CloudEvent.time

事件的时间戳。必须采用 ISO 时间格式。如果未指定,则系统会使用发布时的当前时间。

签名

time?: string;

CloudEvent.type

事件的类型。应带有反向 DNS 名称 (com.my-org.v1.something.happended) 前缀。

签名

type: string;