esppy.evtgen.EventGenerator

class esppy.evtgen.EventGenerator(name=None, insert_only=True, autogen_key=True, publish_target=None, data=None)

Bases: esppy.base.ESPObject

Event generator

Parameters

namestring, optional

Name of the event generator

insert_onlybool, optional

Should duplicate keys be removed?

autogen_keybool, optional

Should keys be generated for events?

publish_targetURL-string or Window, optional

The URL to publish the events to

dataCSV or URL or DataFrame, optional

Event data

Attributes

autogen_keybool, optional

Should keys be generated for events?

dataCSV or URL or DataFrame, optional

Event data

insert_onlybool, optional

Should duplicate keys be removed?

namestring

Name of the event generator

publish_targetURL-string or Window, optional

The URL to publish the events to

resourcesResources dict

The resources for the event generator

initdict

Initialization parameters

fieldsdict

Event data fields

exists_opcodestring

Code to determine upsert or delete for an event

event_datastring

Either a URL to the data, or CSV data

__init__(self, name=None, insert_only=True, autogen_key=True, publish_target=None, data=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self[, name, insert_only, …])	Initialize self.
add_fields(self, \*\*kwargs)	Add fields to generate
add_initializers(self, \*\*kwargs)	Add values to initialize when event generator starts
add_list_resources(self, \*\*kwargs)	Add list resources
add_list_url_resources(self, \*\*kwargs)	Add list URL resources
add_map_resources(self, \*\*kwargs)	Add map resources
add_map_url_resources(self, \*\*kwargs)	Add map URL resources
add_set_resources(self, \*\*kwargs)	Add set resources
add_set_url_resources(self, \*\*kwargs)	Add set URL resources
delete(self)	Delete the event generator
from_element(data[, session])	Create event generator from XML definition
from_xml(data[, session])	Create event generator from XML definition
initialize(self)	Initialize the event generator
save(self[, overwrite, name])	Save the event generator
start(self[, events, blocksize, rate, pause])	Start the generator
stop(self)	Stop the event generator
to_element(self)	Export the event generator definition to an ElementTree.Element
to_xml(self[, pretty])	Export the event generator definition to XML

Attributes

autogen_key
base_url	The base server URL
event_data
insert_only
is_running	Is the event generator current running?
publish_target	The URL to publish the events to
session	The server session object
url	URL of event generator