roboto.domain.events.operations#

Module Contents#

class roboto.domain.events.operations.CreateEventRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for the Create Event operation.

Parameters:: data (Any)

associations: list[roboto.association.Association] = None#: 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.

description: str | None = None#: An optional human-readable description of the event.

display_options: EventDisplayOptions | None = None#: Display options for this 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.

metadata: dict[str, Any] = None#: Initial key-value pairs to associate with this event for discovery and search.

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.

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

tags: list[str] = None#: Initial tags to associate with this event for discovery and search.

class roboto.domain.events.operations.EventDisplayOptions(/, **data)#

Bases: pydantic.BaseModel

Display options for an event.

Parameters:: data (Any)

color: str | None = None#

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)”.

has_options()#

Checks whether any display options have been specified.

Return type:: bool

class roboto.domain.events.operations.EventDisplayOptionsChangeset(/, **data)#

Bases: pydantic.BaseModel

A set of changes to the display options of an event.

Parameters:: data (Any)

apply_to(display_options)#

Applies this changeset to some existing display options.

Parameters:: display_options (EventDisplayOptions)
Return type:: EventDisplayOptions

color: str | None | roboto.sentinels.NotSetType#

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.

has_changes()#

Checks whether this changeset contains any changes.

Return type:: bool

class roboto.domain.events.operations.QueryEventsForAssociationsRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for the Query Events for Associations operation.

Parameters:: data (Any)

associations: list[roboto.association.Association]#: Associations to query events for.

page_token: str | None = None#: Token to use to fetch the next page of results, use None for the first page.

class roboto.domain.events.operations.UpdateEventRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for the Update Event operation. Allows any of the mutable fields of an event to be changed.

Parameters:: data (Any)

description: str | None | roboto.sentinels.NotSetType#: An optional human-readable description of the event.

display_options_changeset: EventDisplayOptionsChangeset | roboto.sentinels.NotSetType#: Display options changes to apply to this event.

end_time: int | roboto.sentinels.NotSetType#: 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.

metadata_changeset: roboto.updates.MetadataChangeset | roboto.sentinels.NotSetType#: Metadata and tag changes to make for this event

model_config#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | roboto.sentinels.NotSetType#: 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.

start_time: int | roboto.sentinels.NotSetType#: The start time of the event, in nanoseconds since epoch (assumed Unix epoch).