Skip to main content

%External.Messaging.KafkaMessage

class %External.Messaging.KafkaMessage extends %External.Messaging.Message

Kafka message

Property Inventory

Method Inventory

Properties

property binaryValue as %Stream.GlobalBinary (%JSONINCLUDE = "NONE");
Binary message value Do not set property "value" when binaryValue is used
Property methods: binaryValueDelete(), binaryValueGet(), binaryValueGetObject(), binaryValueGetObjectId(), binaryValueGetSwizzled(), binaryValueIsValid(), binaryValueNewObject(), binaryValueOid(), binaryValueOpen(), binaryValueSet(), binaryValueSetObject(), binaryValueSetObjectId(), binaryValueUnSwizzle()
property key as %String (MAXLEN = 1000);
Optional message value key
Property methods: keyDisplayToLogical(), keyGet(), keyIsValid(), keyLogicalToDisplay(), keyLogicalToOdbc(), keyNormalize(), keySet()
property offset as %BigInt;
Message offset
Property methods: offsetDisplayToLogical(), offsetGet(), offsetIsValid(), offsetLogicalToDisplay(), offsetNormalize(), offsetSet(), offsetXSDToLogical()
property partition as %Integer;
Message partition number
Property methods: partitionDisplayToLogical(), partitionGet(), partitionIsValid(), partitionLogicalToDisplay(), partitionNormalize(), partitionSet(), partitionXSDToLogical()
property topic as %String (MAXLEN = 1000);
Message topic
Property methods: topicDisplayToLogical(), topicGet(), topicIsValid(), topicLogicalToDisplay(), topicLogicalToOdbc(), topicNormalize(), topicSet()
property value as %String);
Message value as string If the value exceeds maximum length of IRIS string, encode/decode the string from binaryValue using UTF8.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()

Methods

method Copy(source As %External.Messaging.RabbitMQMessage) as %Status
Inherited description: Copy message
method GetHeaderAt(key) as %String
key: header name as %String returns: header as %String or "" in case key is not present
method GetHeaders(Output allHeaders) as %Status
allHeaders: headers as %ArrayOfDataTypes. Make sure to pass the argument with a leading period, as: .allHeaders Returns: status as %Status ($$$OK for success)
method SetHeaderAt(value, key) as %Status
value : header value as %String key: header name as %String returns: status as %Status ($$$OK unless value encoding fails)
method SetHeaders(headers As %ArrayOfDataTypes) as %Status
Set headers Headers contain keys and values as binary strings

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab