esppy.connectors.TimerPublisher

class esppy.connectors.TimerPublisher(basetime=None, interval=None, unit=None, name=None, is_active=None, label=None, timeformat=None, transactional=None, configfilesection=None, publishwithupsert=None, maxevents=None)

Bases: esppy.connectors.base.Connector

Publish events on regular intervals

Parameters

basetimestring

Specifies the start time in the format defined by the timeformat parameter.

intervalfloat

Specifies the interval length in units defined by the unit parameter.

unitstring

Specifies the unit of the interval parameter. Units include second | minute | hour | day | week | month | year.

labelstring, optional

Specifies the string to be written to the source window ‘label’ field. The default value is the connector name.

timeformatstring, optional

Specifies the format of the basetime parameter. The default value is %Y%m-%d %H:%M:%S.

transactionalstring, optional

Sets the event block type to transactional. The default value is normal.

configfilesectionstring, optional

Specifies the name of the section in the connector config file to parse for configuration parameters. Specify the value as [configfilesection].

publishwithupsertboolean, optional

Specifies to build events with opcode = Upsert instead of opcode = Insert.

maxeventsint, optional

Specifies the maximum number of events to publish.

Returns

TimerPublisher

__init__(self, basetime=None, interval=None, unit=None, name=None, is_active=None, label=None, timeformat=None, transactional=None, configfilesection=None, publishwithupsert=None, maxevents=None)

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

Methods

__init__(self[, basetime, interval, unit, …])	Initialize self.
clear(self)
copy(self[, deep])	Return a copy of the object
from_element(data[, session])	Construct connector from XML definition
from_parameters(conncls[, type, name, …])
from_xml(data[, session])	Construct connector from XML definition
get(self, key[, default])
items(self)
keys(self)
pop(self, key[, default])	If key is not found, d is returned if given, otherwise KeyError is raised.
popitem(self)	as a 2-tuple; but raise KeyError if D is empty.
set_properties(self, \*\*kwargs)	Set connector properties
setdefault(self, key[, default])
to_element(self)	Export connector definition to ElementTree.Element
to_xml(self[, pretty])	Export connector definition to XML
update(\*args, \*\*kwds)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values(self)

Attributes

connector_key
property_defs