Interface KafkaAdminOperations

All Known Implementing Classes:
KafkaAdmin
public interface KafkaAdminOperations
Provides a number of convenience methods wrapping AdminClient.
Since:
2.7
Author:
Gary Russell

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    clusterId()
    Return the cluster id, if available.
    void
    createOrModifyTopics(org.apache.kafka.clients.admin.NewTopic... topics)
    Create topics if they don't exist or increase the number of partitions if needed.
    void
    deleteTopics(String... topicNames)
    Delete topics from the Kafka cluster.
    Map<String, org.apache.kafka.clients.admin.TopicDescription>
    describeTopics(String... topicNames)
    Obtain TopicDescriptions for these topics.
    Map<String,Object>
    getConfigurationProperties()
    Get an unmodifiable copy of this admin's configuration.

  • Method Details

    • getConfigurationProperties

      Map<String,Object> getConfigurationProperties()
      Get an unmodifiable copy of this admin's configuration.
      Returns:
      the configuration map.

    • createOrModifyTopics

      void createOrModifyTopics(org.apache.kafka.clients.admin.NewTopic... topics)
      Create topics if they don't exist or increase the number of partitions if needed.
      Parameters:
      topics - the topics.

    • describeTopics

      Map<String, org.apache.kafka.clients.admin.TopicDescription> describeTopics(String... topicNames)
      Obtain TopicDescriptions for these topics.
      Parameters:
      topicNames - the topic names.
      Returns:
      a map of name:topicDescription.

    • deleteTopics

      void deleteTopics(String... topicNames)
      Delete topics from the Kafka cluster.
      Parameters:
      topicNames - the topic names to delete.
      Since:
      4.0

    • clusterId

      @Nullable String clusterId()
      Return the cluster id, if available.
      Returns:
      the describe cluster id.
      Since:
      3.0