KafkaConsumer

hostname

Hostname (Broker)

Defines the broker's IP address

String

topic

Topic

Defines the topic to describe to, the message will be read from that topic. The messages are stored at this topic.

String

groupid

Group ID

Specifies the consumer group to which the Kafka Consumer instance belongs.

String

polltime

Polling time (in ms)

Specifies the maximum time to wait for consumer messages or events. If no records are received before this time expires, Kafka Consumer block returns an empty record set.

Scalar

Offset

Initial Offset

Defines the offset on startup.

Structure

Offset/earliest

Earliest (smallest or beginning)

automatically reset the offset to the smallest offset

Number

0
1

Offset/latest

Latest (largest or end)

automatically reset the offset to the largest offset

Number

0
1

nout

Number of outputs

Defines the number of outputs

Number

outports

Output ports

Defines the data type and size for each output.

Structure

outports/rowsize

Row size

Defines the row size for each output.

Cell of scalars

outports/colsize

Column size

Defines the column size for each output.

Cell of scalars

outports/datatype

Data Type

Defines the data type for each output.

Cell of strings

'double'
'int32'
'int16'
'int8'
'uint32'
'uint16'
'uint8'
'boolean'

messageformat

Message Format

Defines the Format of the message.

Structure

messageformat/text

Text

Number

0
1

messageformat/json

Json

Number

0
1

message

Message

Defines the message format to be read. This message can be of any format (text, JSON, ...). User can use %%1, %%2, ..., %%n to identify the outputs.

String

jsonfields

Json field names

Structure

jsonfields/name

Name

Cell of strings

separator

Array separator

Defines the separator used for arrays elements.

String

onFailure

Do on failure

Defines the behavior on failure.

Structure

onFailure/error

Error

Number

0
1

onFailure/warning

Warning

Number

0
1

onFailure/nothing

Nothing

Number

0
1

log_file_name

Log file name (*.log)

Activate messages are logged into this file. the filename can be 'stderr' or 'stdout'.

String