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 |
Kafka Authentication Description
- Authentication mode: If you configure SASL Username, SASL Password, Truststore, and Truststore Password in the KafkaProducer keyword, and the Kafka uses the SASL_SSL authentication protocol for encrypted data transmission, then client authentication is required.
- No authentication mode: If you do not configure SASL Username, SASL Password, Truststore, and Truststore Password in the KafkaProducer keyword, and the Kafka uses the default SASL_PLAINTEXT protocol, then no encryption or authentication mechanism is used. In this mode, the communication between the client and server is in plaintext, and security cannot be guaranteed.
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot