esppy.connectors.SolacePublisher

class esppy.connectors.SolacePublisher(solhostport=None, soluserid=None, solpassword=None, solvpn=None, soltopic=None, urlhostport=None, name=None, is_active=None, buspersistence=None, buspersistencequeue=None, protofile=None, protomsg=None, configfilesection=None, json=None, publishwithupsert=None, dateformat=None, solpasswordencrypted=None, getmsgfromdestattr=None, transactional=None, blocksize=None, maxevents=None)

Bases: esppy.connectors.base.Connector

Publish events to Solace

Parameters

solhostportstring

Specifies the appliance to connect to, in the form “host:port”

soluseridstring

Specifies the user name required to authenticate the connector’s session with the appliance.

solpasswordstring

Specifies the password associated with soluserid

solvpnstring

Specifies the appliance message VPN to assign the client to which the session connects.

soltopicstring

Specifies the Solace topic to which to subscribe

urlhostportstring

Specifies the host:port field in the metadata topic subscribed to on start-up to field metadata requests.

buspersistenceboolean, optional

Creates the Guaranteed message flow to bind to the topic endpoint provisioned on the appliance that the published Guaranteed messages are delivered and spooled to

buspersistencequeuestring, optional

Specifies the name of the queue to which the Guaranteed message flow binds.

protofilestring, optional

Specifies the .proto file that contains the Google Protocol Buffers message definition used to convert event blocks to protobuf messages. When you specify this parameter, you must also specify the protomsg parameter.

protomsgstring, optional

Specifies the name of a Google Protocol Buffers message in the .proto file that you specified with the protofile parameter. Event blocks are converted into this message.

configfilesectionstring, optional

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

jsonboolean, optional

Enables transport of event blocks encoded as JSON messages

publishwithupsertboolean, optional

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

dateformatstring, optional

Specifies the format of ESP_DATETIME and ESP_TIMESTAMP fields in CSV events. The default behavior is these fields are interpreted as an integer number of seconds (ESP_DATETIME) or microseconds (ESP_TIMESTAMP) since epoch.

solpasswordencryptedboolean, optional

Specifies that solpassword is encrypted

getmsgfromdestattrboolean, optional

Specifies to extract the payload from the destination attribute instead of the message body.

transactionalstring, optional

When getmsgfromdestattr is enabled, sets the event block type to transactional. The default value is normal.

blocksizeint, optional

When getmsgfromdestattr is enabled, specifies the number of events to include in a published event block. The default value is 1.

maxeventsint, optional

Specifies the maximum number of events to publish.

Returns

SolacePublisher

__init__(self, solhostport=None, soluserid=None, solpassword=None, solvpn=None, soltopic=None, urlhostport=None, name=None, is_active=None, buspersistence=None, buspersistencequeue=None, protofile=None, protomsg=None, configfilesection=None, json=None, publishwithupsert=None, dateformat=None, solpasswordencrypted=None, getmsgfromdestattr=None, transactional=None, blocksize=None, maxevents=None)

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

Methods

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