Skip to main content
Version: 8.3 Beta 🚧

system.kafka.listTopicPartitions

This function is used in Python Scripting.

Description​

Returns a list of records that match the filter.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.kafka.listTopicPartitions(connector, topic, groupId, [options])

Parameters​

TypeParameterDescription
StringconnectorThe name of the Kafka connector.
StringtopicThe name of the Kafka topic.
StringgroupIdThe unique string of the consumer group the consumer belongs to.
DictionaryoptionsCustom options specific to the consumer, with key value string pairs. Optional.

Returns​

List - A list of records that match the filter.

Scope​

Gateway

Code Examples​

Example #1
# Returns a list of records according to the parameter filters.
system.kafka.listTopics("MyKafkaConnector", "MyKafkaTopic", "consumer-group-one")