roboto.domain.events.record

Module Contents

class roboto.domain.events.record.EventRecord(/, **data)

Bases: pydantic.BaseModel

A wire-transmissible representation of an event.

Parameters:

data (Any)

associations: list[roboto.association.Association] = None

Datasets, files, topics and message paths which this event pertains to.

created: datetime.datetime

Date/time when this event was created.

created_by: str

The user who created this event.

description: str | None = None

An optional human-readable description of the event.

display_options: roboto.domain.events.operations.EventDisplayOptions | None = None

Display options for the event, such as color.

end_time: int

The end time of the event, in nanoseconds since epoch (assumed Unix epoch). This can be equal to start_time if the event is discrete, but can never be less than start_time.

event_id: str

A globally unique ID used to reference an event.

metadata: dict[str, Any] = None

Key-value pairs to associate with this event for discovery and search.

modified: datetime.datetime

Date/time when this event was last modified.

modified_by: str

The user who last modified this event.

name: str

A brief human-readable name for the event. Many events can have the same name. “Takeoff”, “Crash”, “CPU Spike”, “Bad Image Quality”, and “Unexpected Left” are a few potential examples.

org_id: str

The organization to which this event belongs.

start_time: int

The start time of the event, in nanoseconds since epoch (assumed Unix epoch).

tags: list[str] = None

Tags to associate with this event for discovery and search.