KafkaTopicDescription is a datatype for a Kafka topic description.

This datatype is used by the datatype, KafkaClusterDescription, which is used by the kafkaCluster() query field.

Table: KafkaTopicDescription

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 25, 2024
configKafkaTopicConfigsyes Short-TermThe Kafka configuration set. See KafkaTopicConfigs.
namestringyes Short-TermThe name of the Kafka topic.
partitions[KafkaTopicPartitionDescription]yes Short-TermThe partitions related to the Kafka topic. See KafkaTopicPartitionDescription.