esppy.connectors.NuregoSubscriber

class esppy.connectors.NuregoSubscriber(serviceurl=None, certificate=None, username=None, password=None, instanceid=None, name=None, is_active=None, snapshot=None, certpassword=None, collapse=None, rmretdel=None, configfilesection=None)

Bases: esppy.connectors.base.Connector

Subscribe to Nurego metering window

Parameters

serviceurlstring

Specifies the target Nurego REST service URL

certificatestring

Specifies the full path and filename of the client certificate that is used to establish the HTTPS connection to the Nurego REST service.

usernamestring

Specifies the user name to use in requests to Nurego for a new token

passwordstring

Specifies the password to use in requests to Nurego for a new token

instanceidstring

Specifies the instance ID to use in requests to Nurego for a new token

certpasswordstring, optional

Specifies the password associated with the client certificate that is configured in certificate.

collapsestring, optional

Enables conversion of UPDATE_BLOCK events to make subscriber output publishable. The default value is disabled.

rmretdelboolean, optional

Specifies to remove all delete events from event blocks received by a subscriber that were introduced by a window retention policy.

configfilesectionstring, optional

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

Returns

NuregoSubscriber

__init__(self, serviceurl=None, certificate=None, username=None, password=None, instanceid=None, name=None, is_active=None, snapshot=None, certpassword=None, collapse=None, rmretdel=None, configfilesection=None)

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

Methods

__init__(self[, serviceurl, certificate, …])	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