KafkaAdminClient (Vert.x Stack

java.lang.Object
- io.vertx.rxjava3.kafka.admin.KafkaAdminClient

```
public class KafkaAdminClient
extends Object
```
Vert.x Kafka Admin client implementation
NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields
Modifier and Type Field and Description

static io.vertx.lang.rx.TypeArg<KafkaAdminClient> __TYPE_ARG

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<KafkaAdminClient>`	`__TYPE_ARG`

Constructor Summary

Constructors
Constructor and Description

KafkaAdminClient(KafkaAdminClient delegate)

KafkaAdminClient(Object delegate)

Constructors
Constructor and Description
`KafkaAdminClient(KafkaAdminClient delegate)`
`KafkaAdminClient(Object delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Completable`	`close()` Close the admin client
`Completable`	`close(long timeout)` Close the admin client
`static KafkaAdminClient`	`create(Vertx vertx, Map<String,String> config)` Create a new KafkaAdminClient instance
`Completable`	`createPartitions(Map<String,NewPartitions> partitions)` Creates a batch of new partitions in the Kafka topic
`Completable`	`createTopics(List<NewTopic> topics)` Creates a batch of new Kafka topics
`Completable`	`deleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions)` Delete committed offsets for a set of partitions in a consumer group.
`Completable`	`deleteConsumerGroups(List<String> groupIds)` Delete consumer groups from the cluster.
`Completable`	`deleteTopics(List<String> topicNames)` Deletes a batch of Kafka topics
`Single<ClusterDescription>`	`describeCluster()` Describe the nodes in the cluster with the default options
`Single<Map<String,ConsumerGroupDescription>>`	`describeConsumerGroups(List<String> groupIds)` Describe some group ids in the cluster, with the default options
`Single<Map<String,TopicDescription>>`	`describeTopics(List<String> topicNames)` Describe some topics in the cluster, with the default options.
`boolean`	`equals(Object o)`
`KafkaAdminClient`	`getDelegate()`
`int`	`hashCode()`
`Single<List<ConsumerGroupListing>>`	`listConsumerGroups()` Get the the consumer groups available in the cluster with the default options
`Single<Set<String>>`	`listTopics()` List the topics available in the cluster with the default options.
`static KafkaAdminClient`	`newInstance(KafkaAdminClient arg)`
`Completable`	`rxClose()` Close the admin client
`Completable`	`rxClose(long timeout)` Close the admin client
`Completable`	`rxCreatePartitions(Map<String,NewPartitions> partitions)` Creates a batch of new partitions in the Kafka topic
`Completable`	`rxCreateTopics(List<NewTopic> topics)` Creates a batch of new Kafka topics
`Completable`	`rxDeleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions)` Delete committed offsets for a set of partitions in a consumer group.
`Completable`	`rxDeleteConsumerGroups(List<String> groupIds)` Delete consumer groups from the cluster.
`Completable`	`rxDeleteTopics(List<String> topicNames)` Deletes a batch of Kafka topics
`Single<ClusterDescription>`	`rxDescribeCluster()` Describe the nodes in the cluster with the default options
`Single<Map<String,ConsumerGroupDescription>>`	`rxDescribeConsumerGroups(List<String> groupIds)` Describe some group ids in the cluster, with the default options
`Single<Map<String,TopicDescription>>`	`rxDescribeTopics(List<String> topicNames)` Describe some topics in the cluster, with the default options.
`Single<List<ConsumerGroupListing>>`	`rxListConsumerGroups()` Get the the consumer groups available in the cluster with the default options
`Single<Set<String>>`	`rxListTopics()` List the topics available in the cluster with the default options.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<KafkaAdminClient> __TYPE_ARG
```
- Constructor Detail
  - KafkaAdminClient
```
public KafkaAdminClient(KafkaAdminClient delegate)
```
  - KafkaAdminClient
```
public KafkaAdminClient(Object delegate)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDelegate
```
public KafkaAdminClient getDelegate()
```
  - create
```
public static KafkaAdminClient create(Vertx vertx,
                                      Map<String,String> config)
```
    Create a new KafkaAdminClient instance
    
    Parameters:
    
    vertx - Vert.x instance to use
    
    config - Kafka admin client configuration
    
    Returns:
    
    an instance of the KafkaAdminClient
  - listTopics
```
public Single<Set<String>> listTopics()
```
    List the topics available in the cluster with the default options.
    
    Returns:
  - rxListTopics
```
public Single<Set<String>> rxListTopics()
```
    List the topics available in the cluster with the default options.
    
    Returns:
  - describeTopics
```
public Single<Map<String,TopicDescription>> describeTopics(List<String> topicNames)
```
    Describe some topics in the cluster, with the default options.
    
    Parameters:
    
    topicNames - the names of the topics to describe
    
    Returns:
  - rxDescribeTopics
```
public Single<Map<String,TopicDescription>> rxDescribeTopics(List<String> topicNames)
```
    Describe some topics in the cluster, with the default options.
    
    Parameters:
    
    topicNames - the names of the topics to describe
    
    Returns:
  - createTopics
```
public Completable createTopics(List<NewTopic> topics)
```
    Creates a batch of new Kafka topics
    
    Parameters:
    
    topics - topics to create
    
    Returns:
  - rxCreateTopics
```
public Completable rxCreateTopics(List<NewTopic> topics)
```
    Creates a batch of new Kafka topics
    
    Parameters:
    
    topics - topics to create
    
    Returns:
  - deleteTopics
```
public Completable deleteTopics(List<String> topicNames)
```
    Deletes a batch of Kafka topics
    
    Parameters:
    
    topicNames - the names of the topics to delete
    
    Returns:
  - rxDeleteTopics
```
public Completable rxDeleteTopics(List<String> topicNames)
```
    Deletes a batch of Kafka topics
    
    Parameters:
    
    topicNames - the names of the topics to delete
    
    Returns:
  - createPartitions
```
public Completable createPartitions(Map<String,NewPartitions> partitions)
```
    Creates a batch of new partitions in the Kafka topic
    
    Parameters:
    
    partitions - partitions to create
    
    Returns:
  - rxCreatePartitions
```
public Completable rxCreatePartitions(Map<String,NewPartitions> partitions)
```
    Creates a batch of new partitions in the Kafka topic
    
    Parameters:
    
    partitions - partitions to create
    
    Returns:
  - listConsumerGroups
```
public Single<List<ConsumerGroupListing>> listConsumerGroups()
```
    Get the the consumer groups available in the cluster with the default options
    
    Returns:
  - rxListConsumerGroups
```
public Single<List<ConsumerGroupListing>> rxListConsumerGroups()
```
    Get the the consumer groups available in the cluster with the default options
    
    Returns:
  - describeConsumerGroups
```
public Single<Map<String,ConsumerGroupDescription>> describeConsumerGroups(List<String> groupIds)
```
    Describe some group ids in the cluster, with the default options
    
    Parameters:
    
    groupIds - the ids of the groups to describe
    
    Returns:
  - rxDescribeConsumerGroups
```
public Single<Map<String,ConsumerGroupDescription>> rxDescribeConsumerGroups(List<String> groupIds)
```
    Describe some group ids in the cluster, with the default options
    
    Parameters:
    
    groupIds - the ids of the groups to describe
    
    Returns:
  - describeCluster
```
public Single<ClusterDescription> describeCluster()
```
    Describe the nodes in the cluster with the default options
    
    Returns:
  - rxDescribeCluster
```
public Single<ClusterDescription> rxDescribeCluster()
```
    Describe the nodes in the cluster with the default options
    
    Returns:
  - deleteConsumerGroups
```
public Completable deleteConsumerGroups(List<String> groupIds)
```
    Delete consumer groups from the cluster.
    
    Parameters:
    
    groupIds - the ids of the groups to delete
    
    Returns:
  - rxDeleteConsumerGroups
```
public Completable rxDeleteConsumerGroups(List<String> groupIds)
```
    Delete consumer groups from the cluster.
    
    Parameters:
    
    groupIds - the ids of the groups to delete
    
    Returns:
  - deleteConsumerGroupOffsets
```
public Completable deleteConsumerGroupOffsets(String groupId,
                                              Set<TopicPartition> partitions)
```
    Delete committed offsets for a set of partitions in a consumer group. This will succeed at the partition level only if the group is not actively subscribed to the corresponding topic.
    
    Parameters:
    
    groupId - The group id of the group whose offsets will be deleted
    
    partitions - The set of partitions in the consumer group whose offsets will be deleted
    
    Returns:
  - rxDeleteConsumerGroupOffsets
```
public Completable rxDeleteConsumerGroupOffsets(String groupId,
                                                Set<TopicPartition> partitions)
```
    Delete committed offsets for a set of partitions in a consumer group. This will succeed at the partition level only if the group is not actively subscribed to the corresponding topic.
    
    Parameters:
    
    groupId - The group id of the group whose offsets will be deleted
    
    partitions - The set of partitions in the consumer group whose offsets will be deleted
    
    Returns:
  - close
```
public Completable close()
```
    Close the admin client
    
    Returns:
  - rxClose
```
public Completable rxClose()
```
    Close the admin client
    
    Returns:
  - close
```
public Completable close(long timeout)
```
    Close the admin client
    
    Parameters:
    
    timeout - timeout to wait for closing
    
    Returns:
  - rxClose
```
public Completable rxClose(long timeout)
```
    Close the admin client
    
    Parameters:
    
    timeout - timeout to wait for closing
    
    Returns:
  - newInstance
```
public static KafkaAdminClient newInstance(KafkaAdminClient arg)
```

Class KafkaAdminClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__TYPE_ARG

Constructor Detail

KafkaAdminClient

KafkaAdminClient

Method Detail

toString

equals

hashCode

getDelegate

create

listTopics

rxListTopics

describeTopics

rxDescribeTopics

createTopics

rxCreateTopics

deleteTopics

rxDeleteTopics

createPartitions

rxCreatePartitions

listConsumerGroups

rxListConsumerGroups

describeConsumerGroups

rxDescribeConsumerGroups

describeCluster

rxDescribeCluster

deleteConsumerGroups

rxDeleteConsumerGroups

deleteConsumerGroupOffsets

rxDeleteConsumerGroupOffsets

close

rxClose

close

rxClose

newInstance