Share via

CloudEvent interface

  • Reference
Package:
@azure/eventgrid-namespaces

An event in the Cloud Event 1.0 schema.

Properties

data

Event data specific to the event type.
dataContentType

Content type of data value.
dataSchema

Identifies the schema that data adheres to.
extensionAttributes

Additional context attributes for the event. The Cloud Event specification refers to these as "extension attributes".
id

An identifier for the event. The combination of id and source must be unique for each distinct event.
source

Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event.
specVersion

The version of the CloudEvents specification which the event uses.
subject

This describes the subject of the event in the context of the event producer (identified by source).
time

The time the event was generated.
type

Type of event related to the originating occurrence.

Property Details

data

Event data specific to the event type.

data?: T

Property Value

T

dataContentType

Content type of data value.

dataContentType?: string

Property Value

string

dataSchema

Identifies the schema that data adheres to.

dataSchema?: string

Property Value

string

extensionAttributes

Additional context attributes for the event. The Cloud Event specification refers to these as "extension attributes".

extensionAttributes?: Record<string, unknown>

Property Value

Record<string, unknown>

id

An identifier for the event. The combination of id and source must be unique for each distinct event.

id: string

Property Value

string

source

Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event.

source: string

Property Value

string

specVersion

The version of the CloudEvents specification which the event uses.

specVersion?: string

Property Value

string

subject

This describes the subject of the event in the context of the event producer (identified by source).

subject?: string

Property Value

string

time

The time the event was generated.

time?: Date

Property Value

Date

type

Type of event related to the originating occurrence.

type: string

Property Value

string