vertx-lang-scala-docs_2.12 3.4.2 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package kafka
  Definition Classes
    scala
-  package admin
  Definition Classes
    kafka
- AdminUtils

c

io.vertx.scala.kafka.admin

# AdminUtils 

###
Companion object AdminUtils

#### class AdminUtils extends AnyRef

Provides a wrapper around important methods in Kafka's AdminUtils, namely

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. AdminUtils
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new AdminUtils(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: AnyRef
6.  def changeTopicConfig(topicName: String, topicConfig: Map[String, String], completionHandler: Handler[AsyncResult[Unit]]): Unit

   Updates the configuration of the topic given by topicName.

   Updates the configuration of the topic given by topicName. Configuration parameters are passed in as a Map (Key -> Value) of Strings.

   topicName

     topic to be configured

   topicConfig

     Map with configuration items

   completionHandler

     vert.x callback

7.  def changeTopicConfigFuture(topicName: String, topicConfig: Map[String, String]): Future[Unit]

   Like changeTopicConfig but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

8.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
9.  def close(completionHandler: Handler[AsyncResult[Unit]]): Unit

   Closes the underlying connection to Zookeeper.

   Closes the underlying connection to Zookeeper. It is required to call the method for cleanup purposes if AdminUtils was not created with autoClose set to true.

   completionHandler

     vert.x callback

10.  def closeFuture(): Future[Unit]

    Like close but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

11.  def createTopic(topicName: String, partitionCount: Int, replicationFactor: Int, topicConfig: Map[String, String], completionHandler: Handler[AsyncResult[Unit]]): Unit

    Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s).

    Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s). In contrast to @see io.vertx.scala.kafka.admin.AdminUtils#createTopicFuture, one can pass in additional configuration parameters as a map (String -> String).

    topicName

      Name of the to-be-created topic

    partitionCount

      Number of partitions

    replicationFactor

      Number of replicates. Must be lower or equal to the number of available Brokers

    topicConfig

      map with additional topic configuration parameters

    completionHandler

      vert.x callback

12.  def createTopic(topicName: String, partitionCount: Int, replicationFactor: Int, completionHandler: Handler[AsyncResult[Unit]]): Unit

    Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s)

    Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s)

    topicName

      Name of the to-be-created topic

    partitionCount

      Number of partitions

    replicationFactor

      Number of replicates. Must be lower or equal to the number of available Brokers

    completionHandler

      vert.x callback

13.  def createTopicFuture(topicName: String, partitionCount: Int, replicationFactor: Int, topicConfig: Map[String, String]): Future[Unit]

    Like createTopic but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

14.  def createTopicFuture(topicName: String, partitionCount: Int, replicationFactor: Int): Future[Unit]

    Like createTopic but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

15.  def deleteTopic(topicName: String, completionHandler: Handler[AsyncResult[Unit]]): Unit

    Delete the Kafka topic given by the topicName.

    Delete the Kafka topic given by the topicName.

    topicName

      Name of the topic to be deleted

    completionHandler

      vert.x callback

16.  def deleteTopicFuture(topicName: String): Future[Unit]

    Like deleteTopic but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

17.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
18.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
19.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
20.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
21.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
22.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
23.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
24.  final def notify(): Unit
    Definition Classes
      AnyRef
25.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
26.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
27.  def toString(): String
    Definition Classes
      AnyRef → Any
28.  def topicExists(topicName: String, completionHandler: Handler[AsyncResult[Boolean]]): Unit

    Checks if the Kafka topic given by topicName does exist.

    Checks if the Kafka topic given by topicName does exist.

    topicName

      Name of the topic

    completionHandler

      vert.x callback

29.  def topicExistsFuture(topicName: String): Future[Boolean]

    Like topicExists but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

30.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
31.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
32.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped