Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%External] >  [Messaging] >  [KafkaClient]
Private  Storage   

class %External.Messaging.KafkaClient extends Client

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5


Summary

Properties
gateway jclient

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
Close Connect CreateClient CreateJMSClient
CreateKafkaClient CreateQueueOrTopic CreateRabbitMQClient CreateSNSClient
CreateSQSClient CreateTopic DeleteQueueOrTopic DeleteTopic
ReceiveMessage SendMessage UpdateAdminConfig UpdateConsumerConfig
UpdateProducerConfig


Methods

• method CreateTopic(topicName As %String, numberOfPartitions As %Integer, replicationFactor As %TinyInt) as %Status
Applicable to Kafka.
Create a Kafka Topic with the name
• method DeleteTopic(topicName As %String) as %Status
Delete a Kafka Topic with the name
• method UpdateAdminConfig(adminConfig As %String) as %Status
Applicable to Kafka.
Updates the Admin Client Configurations using the passed in JSON string.
Only pass in configuratiton properties that are applicable to the Kafka's Admin Client. For possilbe admin client configuration properties, please refer to https://kafka.apache.org/documentation/#adminclientconfigs.
• method UpdateConsumerConfig(consumerConfig As %String) as %Status
Applicable to Kafka.
Updates the Consumer Configurations using the passed in JSON string.
Only pass in configuratiton properties that are applicable to the Kafka Consumer. For possible consumer configuration properties, please refer to https://kafka.apache.org/documentation/#consumerconfigs. Sample settings: "{\"key.deserializer\":\"org.apache.kafka.common.serialization.StringDeserializer\"}"
• method UpdateProducerConfig(producerConfig As %String) as %Status
Applicable to Kafka.
Updates the Producer Configurations using the passed in JSON string.
Only pass in configuratiton properties that are applicable to the Kafka Producer. For possible producer configuration properties, please refer to https://kafka.apache.org/documentation/#producerconfigs. Sample settings: "{\"key.serializer\":\"org.apache.kafka.common.serialization.StringSerializer\"}"


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.