CloudEvent interface

CloudEvent はイベントデータを記述します。

署名:

export interface CloudEvent 

プロパティ

CloudEvent.data

イベントのデータ ペイロード。オブジェクトは JSON で文字列化され、文字列はそのまま渡されます。

署名:

data?: object | string;

CloudEvent.datacontenttype

data フィールドのイベントとともに送信されるデータの MIME タイプ。現在サポートされているのは application/json と text/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;