roboto.domain.events.operations
Module Contents
CreateEventRequest
Bases: pydantic.BaseModel
Request payload for the Create Event operation.
Parameters
data AnyAttributes
CreateEventRequest.associations
Datasets, files, topics and message paths which this event relates to. At least one must be provided. All referenced datasets, files, topics and message paths must be owned by the same organization.
CreateEventRequest.custom_fields
Initial values for Ready custom fields on this event.
Each key must be the name of a CustomField that is Ready for the caller’s org and the Event entity type; each value must satisfy the field’s declared type. Names that are undefined or not Ready, and values that don’t match the field’s type, are rejected with a structured error.
CreateEventRequest.description
An optional human-readable description of the event.
CreateEventRequest.display_options
Display options for this event, such as color.
CreateEventRequest.end_time
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.
CreateEventRequest.metadata
Initial key-value pairs to associate with this event for discovery and search.
CreateEventRequest.name
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.
CreateEventRequest.start_time
The start time of the event, in nanoseconds since epoch (assumed Unix epoch).
CreateEventRequest.tags
Initial tags to associate with this event for discovery and search.
DeleteEventsRequest
Bases: pydantic.BaseModel
Request payload for the Delete Events (bulk) operation.
Used to delete multiple events in a single request. Event IDs that don’t exist are silently ignored so the operation is idempotent; an ID the caller isn’t allowed to delete causes the whole request to be rejected.
A single request may contain at most MAX_EVENTS_PER_DELETE_BATCH event IDs; larger requests are rejected. Use roboto.domain.events.Event.delete_many(), which chunks input into batches of this size for you.
Parameters
data AnyAttributes
DeleteEventsRequest.event_ids
IDs of the events to delete. At most MAX_EVENTS_PER_DELETE_BATCH per request.
EventDisplayOptions
Bases: pydantic.BaseModel
Display options for an event.
Parameters
data AnyAttributes
EventDisplayOptions.color
Display color for the event.
Used to visually distinguish events on a timeline, and optionally to signal semantic information about the event (e.g. “red” for events representing critical issues).
Any value that is permissible in CSS to define a valid color can be used here, encoded as a string. For instance, the following are all valid: “red”, “#ff0000”, “rgb(255 0 0)”.
EventDisplayOptions.has_options()
Checks whether any display options have been specified.
Return type
EventDisplayOptionsChangeset
Bases: pydantic.BaseModel
A set of changes to the display options of an event.
Parameters
data AnyEventDisplayOptionsChangeset.apply_to()
Applies this changeset to some existing display options.
Parameters
display_options EventDisplayOptionsReturn type
Attributes
EventDisplayOptionsChangeset.color
An update to an event’s color.
Use None to clear any previously set color value. On the Roboto website, the event will be displayed using an automatically selected color.
EventDisplayOptionsChangeset.has_changes()
Checks whether this changeset contains any changes.
Return type
Attributes
EventDisplayOptionsChangeset.model_config
model_config #Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
MAX_EVENTS_PER_DELETE_BATCH
Maximum number of event IDs the bulk Delete Events API accepts in a single request.
The cap keeps a single delete bounded to one reasonably sized DELETE statement and transaction, so an oversized request can’t make the service or database go nuts. A request that exceeds it is rejected server-side with a 400. roboto.domain.events.Event.delete_many() splits larger inputs into chunks of this size automatically, so SDK callers don’t need to batch by hand.
QueryEventsForAssociationsRequest
Bases: pydantic.BaseModel
Request payload for the Query Events for Associations operation.
Parameters
data AnyAttributes
QueryEventsForAssociationsRequest.associations
Associations to query events for.
QueryEventsForAssociationsRequest.page_token
Token to use to fetch the next page of results, use None for the first page.
UpdateEventRequest
Bases: pydantic.BaseModel
Request payload for the Update Event operation. Allows any of the mutable fields of an event to be changed.
Parameters
data AnyAttributes
UpdateEventRequest.custom_fields_changeset
Changes to apply to Ready custom-field values on this event.
Each referenced field name must be a Ready custom field for this event’s org and the Event entity type; each set_fields value must satisfy the field’s declared type. Names that are undefined or not Ready are rejected with a structured error. Field names not mentioned by the changeset are left unchanged.
UpdateEventRequest.description
An optional human-readable description of the event.
UpdateEventRequest.display_options_changeset
Display options changes to apply to this event.
UpdateEventRequest.end_time
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.
UpdateEventRequest.metadata_changeset
Metadata and tag changes to make for this event
UpdateEventRequest.model_config
model_config #Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
UpdateEventRequest.name
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.
UpdateEventRequest.start_time
The start time of the event, in nanoseconds since epoch (assumed Unix epoch).