Apache Kafka TopicDescribe
CertifiedDescribe a Kafka topic
Apache Kafka TopicDescribe
Describe a Kafka topic
Returns a topic's partition layout (leader, replicas, in-sync replicas) and its effective configuration.
Fails with UnknownTopicOrPartitionException if the topic does not exist.
type: io.kestra.plugin.kafka.TopicDescribeExamples
Inspect a tenant topic's retention config
id: kafka_topic_describe
namespace: company.team
tasks:
- id: topic_describe
type: io.kestra.plugin.kafka.TopicDescribe
properties:
bootstrap.servers: localhost:9092
topic: tenant_acme_orders
- id: log_retention
type: io.kestra.plugin.core.log.Log
message: "retention.ms = {{ outputs.topic_describe.configs['retention.ms'] }}"
Properties
properties *Requiredobject
Kafka AdminClient properties
Must include bootstrap.servers; accepts any Kafka AdminClient config. Provide base64-encoded content for ssl.keystore.location and ssl.truststore.location when using SSL.
topic *Requiredstring
Topic name
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
timeout string
PT30SAdminClient call timeout
Maximum duration to wait for each AdminClient operation to complete before failing the task. Defaults to PT30S (30 seconds).
Outputs
configs object
Effective topic configuration
For example retention.ms, cleanup.policy.
partitionCount integer
Number of partitions
partitions array
Per-partition layout
Each entry contains partition, leader, replicas and isr (in-sync replicas broker IDs).
replicationFactor integer
Replication factor
topic string
Topic name
