event_retrieval
This module contains classes that deals with the retrieval of single standalone events.
OmEventDataRetrieval
See documentation for the __init__ function.
__init__(*, monitor_parameters, source)
Retrieval of single standalone data events.
This class deals with the retrieval of single standalone data events from a data source.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
monitor_parameters |
MonitorParameters
|
An object storing OM's configuration parameters. |
required |
source |
str
|
A string describing the data event source. |
required |
retrieve_event_data(event_id)
Retrieves all data attached to the requested data event.
This function retrieves all the information associated with the data event specified by the provided identifier. The data is returned in the form of a dictionary.
-
Each dictionary key identifies a Data Source in the event for which information has been retrieved.
-
The corresponding dictionary values store the data associated with each Data Source.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event_id |
str
|
a string that uniquely identifies a data event. |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
A dictionary storing all data related the retrieved event. |