roboto.domain.events.record

Module Contents

EventRecord

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

Bases: pydantic.BaseModel

A wire-transmissible representation of an event.

Parameters

data Any

Attributes

EventRecord.associations

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

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

EventRecord.created

created datetime.datetime #

Date/time when this event was created.

EventRecord.created_by

created_by str #

The user who created this event.

EventRecord.custom_fields

custom_fields dict[str, Any] = None #

Values for the custom fields defined on Events in this org.

Every Ready custom field defined for (org_id, Event) appears as a key; values that have not been set surface as None rather than being absent. Empty when no custom fields are defined for the org.

EventRecord.description

description str | None = None #

An optional human-readable description of the event.

EventRecord.display_options

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

Display options for the event, such as color.

EventRecord.end_time

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.

EventRecord.event_id

event_id str #

A globally unique ID used to reference an event.

EventRecord.metadata

metadata dict[str, Any] = None #

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

EventRecord.modified

modified datetime.datetime #

Date/time when this event was last modified.

EventRecord.modified_by

modified_by str #

The user who last modified this event.

EventRecord.name

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.

EventRecord.org_id

org_id str #

The organization to which this event belongs.

EventRecord.start_time

start_time int #

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

EventRecord.tags

tags list[str] = None #

Tags to associate with this event for discovery and search.