EnsLib.Kafka.InboundAdapter
class EnsLib.Kafka.InboundAdapter extends EnsLib.Kafka.Common, EnsLib.Messaging.InboundCommon
Property Inventory
Method Inventory
Parameters
parameter SETTINGS = Topic:Kafka Settings,GroupID:Kafka Settings,ReceiveSettings:Kafka Settings,MaxPollRecords:Kafka Settings,ClientID:Kafka Settings,ConsumerConfig:Kafka Settings;
Inherited description: List of properties can be set as settings in the configuration file
format is a comma separated list of property names
Properties
property ClientID as %String (MAXLEN = 100) [ InitialExpression = "KafkaConsumer" ];
Consumer client ID
Property methods: ClientIDDisplayToLogical(), ClientIDGet(), ClientIDIsValid(), ClientIDLogicalToDisplay(), ClientIDLogicalToOdbc(), ClientIDNormalize(), ClientIDSet()
property ConsumerConfig as %String);
Additional consumer config as a json string
Property methods: ConsumerConfigDisplayToLogical(), ConsumerConfigGet(), ConsumerConfigIsValid(), ConsumerConfigLogicalToDisplay(), ConsumerConfigLogicalToOdbc(), ConsumerConfigNormalize(), ConsumerConfigSet()
property GroupID as %String (MAXLEN = 100);
Kafka consumer group ID. Within the same group, each message is only read once.
Property methods: GroupIDDisplayToLogical(), GroupIDGet(), GroupIDIsValid(), GroupIDLogicalToDisplay(), GroupIDLogicalToOdbc(), GroupIDNormalize(), GroupIDSet()
property MaxPollRecords as %Integer [ InitialExpression = 500 ];
Max number of records to fetch per batch received from the Kafka Broker
Property methods: MaxPollRecordsDisplayToLogical(), MaxPollRecordsGet(), MaxPollRecordsIsValid(), MaxPollRecordsLogicalToDisplay(), MaxPollRecordsNormalize(), MaxPollRecordsSet()
property ReceiveSettings as %String (MAXLEN = 300);
Parameters to receive messages as JSON string
Property methods: ReceiveSettingsDisplayToLogical(), ReceiveSettingsGet(), ReceiveSettingsIsValid(), ReceiveSettingsLogicalToDisplay(), ReceiveSettingsLogicalToOdbc(), ReceiveSettingsNormalize(), ReceiveSettingsSet()
property Topic as %String (MAXLEN = 100);
Topic that the messages are read from.
Property methods: TopicDisplayToLogical(), TopicGet(), TopicIsValid(), TopicLogicalToDisplay(), TopicLogicalToOdbc(), TopicNormalize(), TopicSet()
Methods
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
method PostBatch() as %Status
Inherited description: Action required after processing a batch of messages
Inherited Members
Inherited Properties
- %CredentialsObj
- %WarnedLatest
- BusinessHost
- CallInterval
- Credentials
- ExtraClasspaths
- KeepaliveInterval
- KeyCredentials
- KeyStoreCredentials
- KeyStoreLocation
- RegistryID
- SASLMechanism
- SecurityProtocol
- Servers
- TrustStoreCredentials
- TrustStoreLocation
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- AssignOneSetting()
- CheckConnection()
- ClearAllAppData()
- ClearRuntimeAppData()
- ClearStaticAppData()
- Connect()
- CredentialsSet()
- Disconnect()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- GetSettings()
- OnKeepalive()
- OnTask()
- OnTearDown()
- PostProcessing()
- createSettings()
- getCredentials()