Struct Emit Mark Event Params

View as Markdown

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-pii-redaction -p nemo-relay-ffi -p nemo-relay-types -p nemo-relay-plugin -p nemo-relay-worker-proto -p nemo-relay-worker.

pub struct EmitMarkEventParams<'a> {
    pub name: &'a str,
    pub parent: Option<&'a ScopeHandle>,
    pub data: Option<Json>,
    pub data_schema: Option<DataSchema>,
    pub metadata: Option<Json>,
    pub category: Option<EventCategory>,
    pub category_profile: Option<CategoryProfile>,
    pub timestamp: Option<DateTime<Utc>>,
}

Builder parameters for event.

Fields

name: &'a str

Event name to emit.

parent: Option<&'a ScopeHandle>

Optional explicit parent scope.

data: Option<Json>

Optional JSON payload recorded as the mark data.

data_schema: Option<DataSchema>

Optional schema identifier for the mark data.

metadata: Option<Json>

Optional JSON metadata recorded on the emitted event.

category: Option<EventCategory>

Optional semantic category for the mark.

category_profile: Option<CategoryProfile>

Optional category-specific mark profile.

timestamp: Option<DateTime<Utc>>

Optional timestamp recorded on the emitted mark event. When omitted, the current UTC time is used.

Implementations

impl<'a> EmitMarkEventParams<'a>

impl<'a> EmitMarkEventParams<'a>

builder

pub fn builder() -> EmitMarkEventParamsBuilder<'a, ((), (), (), (), (), (), (), ())>

Create a builder for building EmitMarkEventParams. On the builder, call .name(...), .parent(...)(optional), .data(...)(optional), .data_schema(...)(optional), .metadata(...)(optional), .category(...)(optional), .category_profile(...)(optional), .timestamp(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of EmitMarkEventParams.