Skip to main content

%External.Messaging.KafkaSettings

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

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

Property Inventory

Properties

property autocommit as %Boolean [ InitialExpression = 1 ];
Auto commit flag
Property methods: autocommitDisplayToLogical(), autocommitGet(), autocommitIsValid(), autocommitLogicalToDisplay(), autocommitNormalize(), autocommitSet()
property clientId as %String (MAXLEN = 1000) [ InitialExpression = "KafkaProducer" ];
Client Id for Kafka producer.
Property methods: clientIdDisplayToLogical(), clientIdGet(), clientIdIsValid(), clientIdLogicalToDisplay(), clientIdLogicalToOdbc(), clientIdNormalize(), clientIdSet()
property groupId as %String (MAXLEN = 1000);
Group id for Kafka consumer.
Property methods: groupIdDisplayToLogical(), groupIdGet(), groupIdIsValid(), groupIdLogicalToDisplay(), groupIdLogicalToOdbc(), groupIdNormalize(), groupIdSet()
property keypassword as %String (MAXLEN = 1000);
Key password
Property methods: keypasswordDisplayToLogical(), keypasswordGet(), keypasswordIsValid(), keypasswordLogicalToDisplay(), keypasswordLogicalToOdbc(), keypasswordNormalize(), keypasswordSet()
property keystorelocation as %String (MAXLEN = 1000);
Key store location
Property methods: keystorelocationDisplayToLogical(), keystorelocationGet(), keystorelocationIsValid(), keystorelocationLogicalToDisplay(), keystorelocationLogicalToOdbc(), keystorelocationNormalize(), keystorelocationSet()
property keystorepassword as %String (MAXLEN = 1000);
Key store password
Property methods: keystorepasswordDisplayToLogical(), keystorepasswordGet(), keystorepasswordIsValid(), keystorepasswordLogicalToDisplay(), keystorepasswordLogicalToOdbc(), keystorepasswordNormalize(), keystorepasswordSet()
property maxpollrecords as %Integer [ InitialExpression = 500 ];
Max number of records to fetch
Property methods: maxpollrecordsDisplayToLogical(), maxpollrecordsGet(), maxpollrecordsIsValid(), maxpollrecordsLogicalToDisplay(), maxpollrecordsNormalize(), maxpollrecordsSet(), maxpollrecordsXSDToLogical()
property password as %String (MAXLEN = 1000);
Password used to create Kafka clients to the Kafka server.
Property methods: passwordDisplayToLogical(), passwordGet(), passwordIsValid(), passwordLogicalToDisplay(), passwordLogicalToOdbc(), passwordNormalize(), passwordSet()
property saslmechanism as %String (MAXLEN = 50) [ InitialExpression = "PLAIN" ];
SASL mechanism Posssible values: GSSAPI,PLAIN,SCRAM-SHA-256,SCRAM-SHA-512,OAUTHBEARER Supported mechanism: PLAIN,SCRAM-SHA-256,SCRAM-SHA-512
Property methods: saslmechanismDisplayToLogical(), saslmechanismGet(), saslmechanismIsValid(), saslmechanismLogicalToDisplay(), saslmechanismLogicalToOdbc(), saslmechanismNormalize(), saslmechanismSet()
property securityprotocol as %String (MAXLEN = 50) [ InitialExpression = "SASL_PLAINTEXT" ];
Security protocol between Kafka client and broker Supported protocol: SASL_PLAINTEXT, SASL_SSL
Property methods: securityprotocolDisplayToLogical(), securityprotocolGet(), securityprotocolIsValid(), securityprotocolLogicalToDisplay(), securityprotocolLogicalToOdbc(), securityprotocolNormalize(), securityprotocolSet()
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 methods: serversDisplayToLogical(), serversGet(), serversIsValid(), serversLogicalToDisplay(), serversLogicalToOdbc(), serversNormalize(), serversSet()
property truststorelocation as %String (MAXLEN = 1000);
Trust store location
Property methods: truststorelocationDisplayToLogical(), truststorelocationGet(), truststorelocationIsValid(), truststorelocationLogicalToDisplay(), truststorelocationLogicalToOdbc(), truststorelocationNormalize(), truststorelocationSet()
property truststorepassword as %String (MAXLEN = 1000);
Trust store password
Property methods: truststorepasswordDisplayToLogical(), truststorepasswordGet(), truststorepasswordIsValid(), truststorepasswordLogicalToDisplay(), truststorepasswordLogicalToOdbc(), truststorepasswordNormalize(), truststorepasswordSet()
property username as %String (MAXLEN = 100);
User name used to create Kafka clients to the Kafka server.
Property methods: usernameDisplayToLogical(), usernameGet(), usernameIsValid(), usernameLogicalToDisplay(), usernameLogicalToOdbc(), usernameNormalize(), usernameSet()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab