esppy.connectors.WebSphereMQSubscriber

class esppy.connectors.WebSphereMQSubscriber(mqtype=None, name=None, is_active=None, snapshot=None, mqtopic=None, mqqueue=None, collapse=None, queuemanager=None, dateformat=None, rmretdel=None, configfilesection=None, protofile=None, protomsg=None, usecorrelid=None, csvmsgperevent=None, csvmsgpereventblock=None)

Bases: esppy.connectors.base.Connector

Subscribe to IBM WebSphere MQ events

Parameters

mqtypestring

Specifies binary, CSV, JSON, XML, or the name of a string field in the subscribed window schema.

snapshotboolean, optional

Specifies whether to send snapshot data.

mqtopicstring, optional

Specifies the MQ topic name. Required if mqqueue is not configured.

mqqueuestring, optional

Specifies the MQ queue name. Required if mqtopic is not configured.

collapsestring, optional

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

queuemanagerstring, optional

Specifies the MQ queue manager.

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.

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 connector config file to parse for configuration parameters. Specifies the value as [configfilesection].

protofilestring, optional

Specifies the .proto file that contains the Google Protocol Buffers message definition. This definition is 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.

usecorrelidboolean, optional

Copies the value of the correlid field in the event to the MQ message correlation ID.

csvmsgpereventint, optional

For CSV, specifies to send one message per event. The default is one message per transactional event block or else one message per event.

csvmsgpereventblockint, optional

For CSV, specifies to send one message per event block. The default is one message per transactional event block or else one message per event.

Returns

WebSphereMQSubscriber

__init__(self, mqtype=None, name=None, is_active=None, snapshot=None, mqtopic=None, mqqueue=None, collapse=None, queuemanager=None, dateformat=None, rmretdel=None, configfilesection=None, protofile=None, protomsg=None, usecorrelid=None, csvmsgperevent=None, csvmsgpereventblock=None)

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

Methods

__init__(self[, mqtype, name, is_active, …])	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