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

class %External.Messaging.KafkaSettings extends %External.Messaging.Settings

Settings to create Kafka clients (Consumer, Producer and AdminClient)

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
12


Summary

Properties
clientId groupId keypassword keystorelocation
keystorepassword password saslmechanism securityprotocol
servers truststorelocation truststorepassword username

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %JSONExport
%JSONExportToStream %JSONExportToString %JSONImport %JSONNew
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject FromJSON ToJSON


Properties

• property clientId as %String(MAXLEN=1000) [ InitialExpression = "KafkaProducer" ];
Client Id for Kafka producer.
• property groupId as %String(MAXLEN=1000);
Group id for Kafka consumer.
• property keypassword as %String(MAXLEN=1000);
Key password
• property keystorelocation as %String(MAXLEN=1000);
Key store location
• property keystorepassword as %String(MAXLEN=1000);
Key store password
• property password as %String(MAXLEN=1000);
Password used to create Kafka clients to the Kafka server.
• property saslmechanism as %String(MAXLEN=50) [ InitialExpression = "PLAIN" ];
SASL mechanism Posssible values: GSSAPI,PLAIN,SCRAM-SHA-256,SCRAM-SHA-512,OAUTHBEARER Supported mechanism: PLAIN
• property securityprotocol as %String(MAXLEN=50) [ InitialExpression = "SASL_PLAINTEXT" ];
Security protocol between Kafka client and broker Supported protocol: SASL_PLAINTEXT, SASL_SSL
• property servers as %String(MAXLEN=1000) [ InitialExpression = "localhost:9092" ];
A comma separated list of host/port pairs to use for establishing the initial connection to the Kafka cluster.
• property truststorelocation as %String(MAXLEN=1000);
Trust store location
• property truststorepassword as %String(MAXLEN=1000);
Trust store password
• property username as %String(MAXLEN=100);
User name used to create Kafka clients to the Kafka server.

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