Kafka plug-in structure
- Configuring a Kafka event source
- A Generic event source that receives KafkaEvent type events can be configured in
the following way:
- Bootstrap Server
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required
- Topic
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required
- Security protocol
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required*
- Values:
PLAINTEXT
SASL_PLAINTEXT
SSL
SASL_SSL
- Default: if no security protocol is specified, the
default value is
PLAINTEXT
- identificationAlgo
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required*
- saslMechanism
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required*
- Values:
PLAIN
GSSAPI
SCRAM-SHA-256
OAUTHBEARER
SCRAM-SHA-512
- Default: if no SASL mechanism is specified, the
default value is
PLAIN
- Username
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required*
- Password
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required*
- isPassword
- pollInMS
-
- Type: nonnegativeinteger
- minlength: 1
- maxlength: 1000
- Default: if no value is specified for the interval, the default value is 100
- kerberosPrincipal
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required*
- kerberosKeytab
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required*
- kerberosService
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required*
- groupID
-
- Type: string
- minlength: 1
- maxlength: 1000
- Default: if no group ID is specified, the default value is the name of the event source consumer
Note:- If the
securityProtocol
is set toSSL
orSASL_SSL
, theidentificationAlgo
is used to enable the hostname verification. - If the
securityProtocol
is set toSASL_PLAINTEXT
orSASL_SSL
, thesaslMechanism
is optional. - If the
saslMechanism
is set toPLAIN
,SCRAM-SHA-256
orSCRAM-SHA-512
, theusername
andpassword
are required. - If the
saslMechanism
is set toGSSAPI
, thekerberosPrincipal
,kerberosKeytab
andkerberosService
are required.
- Kafka event condition
- KafkaEvent type event conditions can be configured in job streams specifying the
following required properties:
- Name
- Type
- Event source
Note: When defining event conditions, all the relative fields are case insensitiveYou can also specify any number of properties that filter the events received from the event source:- Message
- Type: string
- Operator:
EQ("=")
orNE("!=")
- minlength: 1
- maxlength: 1000
- Wildcard allowed: true
- Multiple filters: false
- Single predicate: true
- Case sensitive: false
- Key
- Type: string
- Operator:
EQ("=")
orNE("!=")
- minlength: 1
- maxlength: 1000
- Wildcard allowed: true
- Multiple filters: false
- Single predicate: true
- Case sensitive: false
- Partition
- Type: string
- Operator:
EQ("=")
orNE("!=")
- minlength: 1
- maxlength: 1000
- Wildcard allowed: true
- Multiple filters: false
- Single predicate: true
- Case sensitive: false