Updated on 2024-10-11 GMT+08:00

KafkaConsumer

Introduction to KafkaConsumer

This system keyword can be used to test Kafka consumers.

Parameter

Mandatory

Type

Default Value

Description

Broker

Yes

String

127.0.0.1:9093

IP address of a Kafka instance

Topic

Yes

String

-

Topic of a Kafka message

Consumer Group

Yes

String

-

Kafka message consumer group

SASL Username

No

String

-

Kafka SASL username

SASL Password

No

String

-

Kafka SASL password

Truststore

No

File

-

Kafka client certificate

Truststore Password

No

String

-

Password of the Kafka client certificate

KafkaConsumer Response

Status: success

Parameter

Type

Description

Body

String

Value returned by the KafkaConsumer API

KafkaConsumer Response Example

{
  "message" : [{
    "offset" : 102130,
    "value" : "kafka message 1"
  }, {
    "offset" : 102131,
    "value" : "kafka message 2"
  }]
}

Default Checkpoint

Name

Expected Value

Result

Success

KafkaConsumer Usage Example

Configure parameters to receive a Kafka message.