Package io.vertx.reactivex.kafka.admin
Class KafkaAdminClient
- java.lang.Object
-
- io.vertx.reactivex.kafka.admin.KafkaAdminClient
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<KafkaAdminClient>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description KafkaAdminClient(KafkaAdminClient delegate)
KafkaAdminClient(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Close the admin clientvoid
close(long timeout)
Close the admin clientvoid
close(long timeout, Handler<AsyncResult<Void>> handler)
Close the admin clientvoid
close(Handler<AsyncResult<Void>> handler)
Close the admin clientstatic KafkaAdminClient
create(Vertx vertx, Map<String,String> config)
Create a new KafkaAdminClient instancevoid
createAcls(List<org.apache.kafka.common.acl.AclBinding> aclBindings)
Create the ACL rules.void
createAcls(List<org.apache.kafka.common.acl.AclBinding> aclBindings, Handler<AsyncResult<List<org.apache.kafka.common.acl.AclBinding>>> completionHandler)
Create the ACL rules.void
createPartitions(Map<String,NewPartitions> partitions)
Creates a batch of new partitions in the Kafka topicvoid
createPartitions(Map<String,NewPartitions> partitions, Handler<AsyncResult<Void>> completionHandler)
Creates a batch of new partitions in the Kafka topicvoid
createTopics(List<NewTopic> topics)
Creates a batch of new Kafka topicsvoid
createTopics(List<NewTopic> topics, Handler<AsyncResult<Void>> completionHandler)
Creates a batch of new Kafka topicsvoid
deleteAcls(List<org.apache.kafka.common.acl.AclBindingFilter> aclBindings)
Delete the ACL rules.void
deleteAcls(List<org.apache.kafka.common.acl.AclBindingFilter> aclBindings, Handler<AsyncResult<List<org.apache.kafka.common.acl.AclBinding>>> completionHandler)
Delete the ACL rules.void
deleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions)
Delete committed offsets for a set of partitions in a consumer group.void
deleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions, Handler<AsyncResult<Void>> completionHandler)
Delete committed offsets for a set of partitions in a consumer group.void
deleteConsumerGroups(List<String> groupIds)
Delete consumer groups from the cluster.void
deleteConsumerGroups(List<String> groupIds, Handler<AsyncResult<Void>> completionHandler)
Delete consumer groups from the cluster.void
deleteTopics(List<String> topicNames)
Deletes a batch of Kafka topicsvoid
deleteTopics(List<String> topicNames, Handler<AsyncResult<Void>> completionHandler)
Deletes a batch of Kafka topicsvoid
describeAcls(org.apache.kafka.common.acl.AclBindingFilter aclBindingFilter)
Describe the ACL rules.void
describeAcls(org.apache.kafka.common.acl.AclBindingFilter aclBindingFilter, Handler<AsyncResult<List<org.apache.kafka.common.acl.AclBinding>>> completionHandler)
Describe the ACL rules.void
describeCluster()
Describe the nodes in the cluster with the default optionsvoid
describeCluster(Handler<AsyncResult<ClusterDescription>> completionHandler)
Describe the nodes in the cluster with the default optionsvoid
describeCluster(DescribeClusterOptions options)
LikedescribeCluster(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.kafka.admin.ClusterDescription>>)
but allows customized options.void
describeCluster(DescribeClusterOptions options, Handler<AsyncResult<ClusterDescription>> completionHandler)
LikedescribeCluster(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.kafka.admin.ClusterDescription>>)
but allows customized options.void
describeConsumerGroups(List<String> groupIds)
Describe some group ids in the cluster, with the default optionsvoid
describeConsumerGroups(List<String> groupIds, Handler<AsyncResult<Map<String,ConsumerGroupDescription>>> completionHandler)
Describe some group ids in the cluster, with the default optionsvoid
describeConsumerGroups(List<String> groupIds, DescribeConsumerGroupsOptions options)
void
describeConsumerGroups(List<String> groupIds, DescribeConsumerGroupsOptions options, Handler<AsyncResult<Map<String,ConsumerGroupDescription>>> completionHandler)
void
describeTopics(List<String> topicNames)
Describe some topics in the cluster, with the default options.void
describeTopics(List<String> topicNames, Handler<AsyncResult<Map<String,TopicDescription>>> completionHandler)
Describe some topics in the cluster, with the default options.void
describeTopics(List<String> topicNames, DescribeTopicsOptions options)
void
describeTopics(List<String> topicNames, DescribeTopicsOptions options, Handler<AsyncResult<Map<String,TopicDescription>>> completionHandler)
boolean
equals(Object o)
KafkaAdminClient
getDelegate()
int
hashCode()
void
listConsumerGroups()
Get the the consumer groups available in the cluster with the default optionsvoid
listConsumerGroups(Handler<AsyncResult<List<ConsumerGroupListing>>> completionHandler)
Get the the consumer groups available in the cluster with the default optionsvoid
listTopics()
List the topics available in the cluster with the default options.void
listTopics(Handler<AsyncResult<Set<String>>> completionHandler)
List the topics available in the cluster with the default options.static KafkaAdminClient
newInstance(KafkaAdminClient arg)
io.reactivex.Completable
rxClose()
Close the admin clientio.reactivex.Completable
rxClose(long timeout)
Close the admin clientio.reactivex.Single<List<org.apache.kafka.common.acl.AclBinding>>
rxCreateAcls(List<org.apache.kafka.common.acl.AclBinding> aclBindings)
Create the ACL rules.io.reactivex.Completable
rxCreatePartitions(Map<String,NewPartitions> partitions)
Creates a batch of new partitions in the Kafka topicio.reactivex.Completable
rxCreateTopics(List<NewTopic> topics)
Creates a batch of new Kafka topicsio.reactivex.Single<List<org.apache.kafka.common.acl.AclBinding>>
rxDeleteAcls(List<org.apache.kafka.common.acl.AclBindingFilter> aclBindings)
Delete the ACL rules.io.reactivex.Completable
rxDeleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions)
Delete committed offsets for a set of partitions in a consumer group.io.reactivex.Completable
rxDeleteConsumerGroups(List<String> groupIds)
Delete consumer groups from the cluster.io.reactivex.Completable
rxDeleteTopics(List<String> topicNames)
Deletes a batch of Kafka topicsio.reactivex.Single<List<org.apache.kafka.common.acl.AclBinding>>
rxDescribeAcls(org.apache.kafka.common.acl.AclBindingFilter aclBindingFilter)
Describe the ACL rules.io.reactivex.Single<ClusterDescription>
rxDescribeCluster()
Describe the nodes in the cluster with the default optionsio.reactivex.Single<ClusterDescription>
rxDescribeCluster(DescribeClusterOptions options)
LikedescribeCluster(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.kafka.admin.ClusterDescription>>)
but allows customized options.io.reactivex.Single<Map<String,ConsumerGroupDescription>>
rxDescribeConsumerGroups(List<String> groupIds)
Describe some group ids in the cluster, with the default optionsio.reactivex.Single<Map<String,ConsumerGroupDescription>>
rxDescribeConsumerGroups(List<String> groupIds, DescribeConsumerGroupsOptions options)
io.reactivex.Single<Map<String,TopicDescription>>
rxDescribeTopics(List<String> topicNames)
Describe some topics in the cluster, with the default options.io.reactivex.Single<Map<String,TopicDescription>>
rxDescribeTopics(List<String> topicNames, DescribeTopicsOptions options)
io.reactivex.Single<List<ConsumerGroupListing>>
rxListConsumerGroups()
Get the the consumer groups available in the cluster with the default optionsio.reactivex.Single<Set<String>>
rxListTopics()
List the topics available in the cluster with the default options.String
toString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<KafkaAdminClient> __TYPE_ARG
-
-
Constructor Detail
-
KafkaAdminClient
public KafkaAdminClient(KafkaAdminClient delegate)
-
KafkaAdminClient
public KafkaAdminClient(Object delegate)
-
-
Method Detail
-
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 useconfig
- Kafka admin client configuration- Returns:
- an instance of the KafkaAdminClient
-
listTopics
public void listTopics(Handler<AsyncResult<Set<String>>> completionHandler)
List the topics available in the cluster with the default options.- Parameters:
completionHandler
- handler called on operation completed with the topics set
-
listTopics
public void listTopics()
List the topics available in the cluster with the default options.
-
rxListTopics
public io.reactivex.Single<Set<String>> rxListTopics()
List the topics available in the cluster with the default options.- Returns:
-
describeTopics
public void describeTopics(List<String> topicNames, Handler<AsyncResult<Map<String,TopicDescription>>> completionHandler)
Describe some topics in the cluster, with the default options.- Parameters:
topicNames
- the names of the topics to describecompletionHandler
- handler called on operation completed with the topics descriptions
-
describeTopics
public void describeTopics(List<String> topicNames)
Describe some topics in the cluster, with the default options.- Parameters:
topicNames
- the names of the topics to describe
-
rxDescribeTopics
public io.reactivex.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:
-
describeTopics
public void describeTopics(List<String> topicNames, DescribeTopicsOptions options, Handler<AsyncResult<Map<String,TopicDescription>>> completionHandler)
LikedescribeTopics(java.util.List<java.lang.String>, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.Map<java.lang.String, io.vertx.kafka.admin.TopicDescription>>>)
but allows for customised otions- Parameters:
topicNames
-options
-completionHandler
-
-
describeTopics
public void describeTopics(List<String> topicNames, DescribeTopicsOptions options)
LikedescribeTopics(java.util.List<java.lang.String>, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.Map<java.lang.String, io.vertx.kafka.admin.TopicDescription>>>)
but allows for customised otions- Parameters:
topicNames
-options
-
-
rxDescribeTopics
public io.reactivex.Single<Map<String,TopicDescription>> rxDescribeTopics(List<String> topicNames, DescribeTopicsOptions options)
LikedescribeTopics(java.util.List<java.lang.String>, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.Map<java.lang.String, io.vertx.kafka.admin.TopicDescription>>>)
but allows for customised otions- Parameters:
topicNames
-options
-- Returns:
-
createTopics
public void createTopics(List<NewTopic> topics, Handler<AsyncResult<Void>> completionHandler)
Creates a batch of new Kafka topics- Parameters:
topics
- topics to createcompletionHandler
- handler called on operation completed
-
createTopics
public void createTopics(List<NewTopic> topics)
Creates a batch of new Kafka topics- Parameters:
topics
- topics to create
-
rxCreateTopics
public io.reactivex.Completable rxCreateTopics(List<NewTopic> topics)
Creates a batch of new Kafka topics- Parameters:
topics
- topics to create- Returns:
-
deleteTopics
public void deleteTopics(List<String> topicNames, Handler<AsyncResult<Void>> completionHandler)
Deletes a batch of Kafka topics- Parameters:
topicNames
- the names of the topics to deletecompletionHandler
- handler called on operation completed
-
deleteTopics
public void deleteTopics(List<String> topicNames)
Deletes a batch of Kafka topics- Parameters:
topicNames
- the names of the topics to delete
-
rxDeleteTopics
public io.reactivex.Completable rxDeleteTopics(List<String> topicNames)
Deletes a batch of Kafka topics- Parameters:
topicNames
- the names of the topics to delete- Returns:
-
createPartitions
public void createPartitions(Map<String,NewPartitions> partitions, Handler<AsyncResult<Void>> completionHandler)
Creates a batch of new partitions in the Kafka topic- Parameters:
partitions
- partitions to createcompletionHandler
- handler called on operation completed
-
createPartitions
public void createPartitions(Map<String,NewPartitions> partitions)
Creates a batch of new partitions in the Kafka topic- Parameters:
partitions
- partitions to create
-
rxCreatePartitions
public io.reactivex.Completable rxCreatePartitions(Map<String,NewPartitions> partitions)
Creates a batch of new partitions in the Kafka topic- Parameters:
partitions
- partitions to create- Returns:
-
listConsumerGroups
public void listConsumerGroups(Handler<AsyncResult<List<ConsumerGroupListing>>> completionHandler)
Get the the consumer groups available in the cluster with the default options- Parameters:
completionHandler
- handler called on operation completed with the consumer groups ids
-
listConsumerGroups
public void listConsumerGroups()
Get the the consumer groups available in the cluster with the default options
-
rxListConsumerGroups
public io.reactivex.Single<List<ConsumerGroupListing>> rxListConsumerGroups()
Get the the consumer groups available in the cluster with the default options- Returns:
-
describeConsumerGroups
public void describeConsumerGroups(List<String> groupIds, Handler<AsyncResult<Map<String,ConsumerGroupDescription>>> completionHandler)
Describe some group ids in the cluster, with the default options- Parameters:
groupIds
- the ids of the groups to describecompletionHandler
- handler called on operation completed with the consumer groups descriptions
-
describeConsumerGroups
public void describeConsumerGroups(List<String> groupIds)
Describe some group ids in the cluster, with the default options- Parameters:
groupIds
- the ids of the groups to describe
-
rxDescribeConsumerGroups
public io.reactivex.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:
-
describeConsumerGroups
public void describeConsumerGroups(List<String> groupIds, DescribeConsumerGroupsOptions options, Handler<AsyncResult<Map<String,ConsumerGroupDescription>>> completionHandler)
LikedescribeConsumerGroups(java.util.List<java.lang.String>, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.Map<java.lang.String, io.vertx.kafka.admin.ConsumerGroupDescription>>>)
but allows customized options- Parameters:
groupIds
-options
-completionHandler
-
-
describeConsumerGroups
public void describeConsumerGroups(List<String> groupIds, DescribeConsumerGroupsOptions options)
LikedescribeConsumerGroups(java.util.List<java.lang.String>, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.Map<java.lang.String, io.vertx.kafka.admin.ConsumerGroupDescription>>>)
but allows customized options- Parameters:
groupIds
-options
-
-
rxDescribeConsumerGroups
public io.reactivex.Single<Map<String,ConsumerGroupDescription>> rxDescribeConsumerGroups(List<String> groupIds, DescribeConsumerGroupsOptions options)
LikedescribeConsumerGroups(java.util.List<java.lang.String>, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.Map<java.lang.String, io.vertx.kafka.admin.ConsumerGroupDescription>>>)
but allows customized options- Parameters:
groupIds
-options
-- Returns:
-
describeCluster
public void describeCluster(Handler<AsyncResult<ClusterDescription>> completionHandler)
Describe the nodes in the cluster with the default options- Parameters:
completionHandler
- handler called on operation completed with the cluster description
-
describeCluster
public void describeCluster()
Describe the nodes in the cluster with the default options
-
rxDescribeCluster
public io.reactivex.Single<ClusterDescription> rxDescribeCluster()
Describe the nodes in the cluster with the default options- Returns:
-
describeCluster
public void describeCluster(DescribeClusterOptions options, Handler<AsyncResult<ClusterDescription>> completionHandler)
LikedescribeCluster(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.kafka.admin.ClusterDescription>>)
but allows customized options.- Parameters:
options
-completionHandler
-
-
describeCluster
public void describeCluster(DescribeClusterOptions options)
LikedescribeCluster(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.kafka.admin.ClusterDescription>>)
but allows customized options.- Parameters:
options
-
-
rxDescribeCluster
public io.reactivex.Single<ClusterDescription> rxDescribeCluster(DescribeClusterOptions options)
LikedescribeCluster(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.kafka.admin.ClusterDescription>>)
but allows customized options.- Parameters:
options
-- Returns:
-
deleteConsumerGroups
public void deleteConsumerGroups(List<String> groupIds, Handler<AsyncResult<Void>> completionHandler)
Delete consumer groups from the cluster.- Parameters:
groupIds
- the ids of the groups to deletecompletionHandler
- handler called on operation completed
-
deleteConsumerGroups
public void deleteConsumerGroups(List<String> groupIds)
Delete consumer groups from the cluster.- Parameters:
groupIds
- the ids of the groups to delete
-
rxDeleteConsumerGroups
public io.reactivex.Completable rxDeleteConsumerGroups(List<String> groupIds)
Delete consumer groups from the cluster.- Parameters:
groupIds
- the ids of the groups to delete- Returns:
-
deleteConsumerGroupOffsets
public void deleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions, Handler<AsyncResult<Void>> completionHandler)
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 deletedpartitions
- The set of partitions in the consumer group whose offsets will be deletedcompletionHandler
-
-
deleteConsumerGroupOffsets
public void 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 deletedpartitions
- The set of partitions in the consumer group whose offsets will be deleted
-
rxDeleteConsumerGroupOffsets
public io.reactivex.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 deletedpartitions
- The set of partitions in the consumer group whose offsets will be deleted- Returns:
-
close
public void close(Handler<AsyncResult<Void>> handler)
Close the admin client- Parameters:
handler
- aHandler
completed with the operation result
-
close
public void close()
Close the admin client
-
rxClose
public io.reactivex.Completable rxClose()
Close the admin client- Returns:
-
close
public void close(long timeout, Handler<AsyncResult<Void>> handler)
Close the admin client- Parameters:
timeout
- timeout to wait for closinghandler
- aHandler
completed with the operation result
-
close
public void close(long timeout)
Close the admin client- Parameters:
timeout
- timeout to wait for closing
-
rxClose
public io.reactivex.Completable rxClose(long timeout)
Close the admin client- Parameters:
timeout
- timeout to wait for closing- Returns:
-
describeAcls
public void describeAcls(org.apache.kafka.common.acl.AclBindingFilter aclBindingFilter, Handler<AsyncResult<List<org.apache.kafka.common.acl.AclBinding>>> completionHandler)
Describe the ACL rules.- Parameters:
aclBindingFilter
- The filter to use.completionHandler
- handler called on operation completed with the ACL description result.
-
describeAcls
public void describeAcls(org.apache.kafka.common.acl.AclBindingFilter aclBindingFilter)
Describe the ACL rules.- Parameters:
aclBindingFilter
- The filter to use.
-
rxDescribeAcls
public io.reactivex.Single<List<org.apache.kafka.common.acl.AclBinding>> rxDescribeAcls(org.apache.kafka.common.acl.AclBindingFilter aclBindingFilter)
Describe the ACL rules.- Parameters:
aclBindingFilter
- The filter to use.- Returns:
-
createAcls
public void createAcls(List<org.apache.kafka.common.acl.AclBinding> aclBindings, Handler<AsyncResult<List<org.apache.kafka.common.acl.AclBinding>>> completionHandler)
Create the ACL rules.- Parameters:
aclBindings
- The ACL to create.completionHandler
- handler called on operation completed with the ACL creation result.
-
createAcls
public void createAcls(List<org.apache.kafka.common.acl.AclBinding> aclBindings)
Create the ACL rules.- Parameters:
aclBindings
- The ACL to create.
-
rxCreateAcls
public io.reactivex.Single<List<org.apache.kafka.common.acl.AclBinding>> rxCreateAcls(List<org.apache.kafka.common.acl.AclBinding> aclBindings)
Create the ACL rules.- Parameters:
aclBindings
- The ACL to create.- Returns:
-
deleteAcls
public void deleteAcls(List<org.apache.kafka.common.acl.AclBindingFilter> aclBindings, Handler<AsyncResult<List<org.apache.kafka.common.acl.AclBinding>>> completionHandler)
Delete the ACL rules.- Parameters:
aclBindings
- The filter to delete matching ACLs.completionHandler
- handler called on operation completed with the ACL deletion result.
-
deleteAcls
public void deleteAcls(List<org.apache.kafka.common.acl.AclBindingFilter> aclBindings)
Delete the ACL rules.- Parameters:
aclBindings
- The filter to delete matching ACLs.
-
rxDeleteAcls
public io.reactivex.Single<List<org.apache.kafka.common.acl.AclBinding>> rxDeleteAcls(List<org.apache.kafka.common.acl.AclBindingFilter> aclBindings)
Delete the ACL rules.- Parameters:
aclBindings
- The filter to delete matching ACLs.- Returns:
-
newInstance
public static KafkaAdminClient newInstance(KafkaAdminClient arg)
-
-