esppy.connectors.WebSphereMQPublisher

class esppy.connectors.WebSphereMQPublisher(mqtype=None, name=None, is_active=None, mqtopic=None, mqqueue=None, mqsubname=None, blocksize=None, transactional=None, dateformat=None, queuemanager=None, configfilesection=None, ignorecsvparseerrors=None, protofile=None, protomsg=None, csvfielddelimiter=None, noautogenfield=None, publishwithupsert=None, addcsvopcode=None, addcsvflags=None, usecorrelid=None, ignoremqmdformat=None, maxevents=None)

Bases: esppy.connectors.base.Connector

Publish IBM WebSphere MQ events

Parameters

mqtypestring

Specifies binary, CSV, JSON, XML, or opaquestring. For opaquestring, the Source window schema is assumed to be “index:int64,message:string”.

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.

mqsubnamestring, optional

Specifies the MQ subscription name. Required if mqtopic is configured.

blocksizeint, optional

Specifies the number of events to include in a published event block. The default value is 1.

transactionalstring, optional

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

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.

queuemanagerstring, optional

Specifies the MQ queue manager.

configfilesectionstring, optional

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

ignorecsvparseerrorsboolean, optional

Specifies that when a field in an input CSV event cannot be parsed, the event is dropped, an error is logged, and publishing continues.

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.

csvfielddelimiterstring, optional

Specifies the character delimiter for field data in input CSV events. The default delimiter is the , character.

noautogenfieldboolean, optional

Specifies that input events are missing the key field that is autogenerated by the source window.

publishwithupsertboolean, optional

Builds events with opcode=Upsert instead of Insert.

addcsvopcodeboolean, optional

Prepends an opcode and comma to input CSV events. The opcode is Insert unless publishwithupsert is enabled.

addcsvflagsstring, optional

Specifies the event type to insert into input CSV events (with a comma). Valid values are “normal” and “partialupdate”.

usecorrelidboolean, optional

Copies the value of the MQ message correlation ID into the correlid field in every Event Stream Processing event.

ignoremqmdformatstring, optional

Specifies to ignore the value of the Message Descriptor Format parameter, and assume the message format is compatible with the mqtype parameter setting.

maxeventsint, optional

Specifies the maximum number of events to publish.

Returns

WebSphereMQPublisher

__init__(self, mqtype=None, name=None, is_active=None, mqtopic=None, mqqueue=None, mqsubname=None, blocksize=None, transactional=None, dateformat=None, queuemanager=None, configfilesection=None, ignorecsvparseerrors=None, protofile=None, protomsg=None, csvfielddelimiter=None, noautogenfield=None, publishwithupsert=None, addcsvopcode=None, addcsvflags=None, usecorrelid=None, ignoremqmdformat=None, maxevents=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