CloudEvent داده های رویداد را توصیف می کند.
امضا:
export interface CloudEvent
خواص
| ویژگی | تایپ کنید | شرح |
|---|---|---|
| داده ها | شی | رشته | محموله داده های رویداد. اشیا با JSON رشته‌بندی می‌شوند و رشته‌ها همانطور که هست منتقل می‌شوند. |
| نوع محتوای داده | رشته | نوع MIME داده هایی که با رویداد در فیلد data ارسال می شوند. در حال حاضر فقط application/json و text/plain پشتیبانی می شوند. اگر مشخص نشده باشد، به طور خودکار از نوع داده های ارائه شده استنباط می شود. |
| شناسه | رشته | شناسه رویداد اگر ارائه نشود، به طور خودکار با UUID پر می شود. |
| منبع | رشته | زمینه ای را که یک رویداد در آن اتفاق افتاده را مشخص می کند. اگر ارائه نشده باشد، از مقدار متغیر محیطی EVENTARC_CLOUD_EVENT_SOURCE استفاده می شود و اگر تنظیم نشود، یک خطای اعتبارسنجی داده می شود. |
| اسپکورژن | CloudEventVersion | نسخه ای از مشخصات CloudEvents که رویداد از آن استفاده می کند. اگر ارائه نشده باشد، روی 1.0 تنظیم می شود -- تنها مقدار پشتیبانی شده. |
| موضوع | رشته | موضوع (زمینه) رویداد در زمینه تولید کننده رویداد. |
| زمان | رشته | مهر زمانی رویداد باید در قالب زمان ISO باشد. اگر مشخص نشده باشد، از زمان فعلی (در لحظه انتشار) استفاده می شود. |
| نوع | رشته | نوع رویداد باید با یک نام معکوس DNS پیشوند شود ( com.my-org.v1.something.happended ). |
CloudEvent.data
محموله داده های رویداد. اشیا با JSON رشته‌بندی می‌شوند و رشته‌ها همانطور که هست منتقل می‌شوند.
امضا:
data?: object | string;
CloudEvent.datacontenttype
نوع MIME داده هایی که با رویداد در فیلد data ارسال می شوند. در حال حاضر فقط 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;