Type Alias CreateArvoEvent<TData, TType>

CreateArvoEvent<TData, TType>: {
    accesscontrol?: string;
    data: TData;
    datacontenttype?: string;
    dataschema?: string;
    executionunits?: number;
    id?: string;
    redirectto?: string;
    source: string;
    specversion?: "1.0";
    subject: string;
    time?: string;
    to?: string;
    traceparent?: string;
    tracestate?: string;
    type: TType;
}

Represents the input parameters for creating an ArvoEvent.

Type Parameters

  • TData extends ArvoEventData

    The type of the event data, extending ArvoEventData.

  • TType extends string

    The type name of the event

Type declaration

  • Optionalaccesscontrol?: string

    Defines access controls for the event. Can be a UserID, encrypted string, or key-value pairs.

  • data: TData

    The event payload. This payload must be JSON serializable.

  • Optionaldatacontenttype?: string

    Content type of the data value. Must include 'application/cloudevents+json' or 'application/json'. For an ArvoEvent, it is set automatically to 'application/cloudevents+json;charset=UTF-8;profile=arvo'

  • Optionaldataschema?: string

    Identifies the schema that data adheres to. Must be a valid URI if present.

  • Optionalexecutionunits?: number

    Represents the cost associated with generating the cloudevent.

  • Optionalid?: string

    Unique identifier of the event. Must be a non-empty string. If not provided, a UUID will be generated.

  • Optionalredirectto?: string

    Indicates alternative recipients or destinations for events. Must be a valid URI if present.

  • source: string

    Identifies the context in which an event happened. Must be a valid URI representing the event producer.

  • Optionalspecversion?: "1.0"

    The version of the CloudEvents specification used. Must be '1.0' for this version.

  • subject: string

    Identifies the subject of the event. For Arvo, this must be the Process Id.

  • Optionaltime?: string

    Timestamp of when the occurrence happened. Must be in ISO 8601 format with timezone offset.

  • Optionalto?: string

    Defines the consumer machine of the event. Used for event routing. Must be a valid URI if present.

  • Optionaltraceparent?: string

    Contains trace context information for distributed tracing (OpenTelemetry).

  • Optionaltracestate?: string

    Conveys vendor-specific trace information across service boundaries (OpenTelemetry).

  • type: TType

    Describes the type of event. Should be prefixed with a reverse-DNS name.

Settings

Member Visibility