org.apache.kafka.clients.admin

Class KafkaAdminClient

java.lang.Object

org.apache.kafka.clients.admin.AdminClient

org.apache.kafka.clients.admin.KafkaAdminClient

All Implemented Interfaces:

java.lang.AutoCloseable

@InterfaceStability.Evolving
public class KafkaAdminClient
extends AdminClient

The default implementation of AdminClient. An instance of this class is created by invoking one of the create() methods in AdminClient. Users should not refer to this class directly. The API of this class is evolving, see AdminClient for details.

Method Summary

Methods

Modifier and Type	Method and Description
AlterConfigsResult	alterConfigs(java.util.Map<ConfigResource,Config> configs, AlterConfigsOptions options) Update the configuration for the specified resources with the default options.
void	close(long duration, java.util.concurrent.TimeUnit unit) Close the AdminClient and release all associated resources.
CreateAclsResult	createAcls(java.util.Collection<AclBinding> acls, CreateAclsOptions options) Creates access control lists (ACLs) which are bound to specific resources.
CreateTopicsResult	createTopics(java.util.Collection<NewTopic> newTopics, CreateTopicsOptions options) Create a batch of new topics.
DeleteAclsResult	deleteAcls(java.util.Collection<AclBindingFilter> filters, DeleteAclsOptions options) Deletes access control lists (ACLs) according to the supplied filters.
DeleteTopicsResult	deleteTopics(java.util.Collection<java.lang.String> topicNames, DeleteTopicsOptions options) Delete a batch of topics.
DescribeAclsResult	describeAcls(AclBindingFilter filter, DescribeAclsOptions options) Lists access control lists (ACLs) according to the supplied filter.
DescribeClusterResult	describeCluster(DescribeClusterOptions options) Get information about the nodes in the cluster.
DescribeConfigsResult	describeConfigs(java.util.Collection<ConfigResource> configResources, DescribeConfigsOptions options) Get the configuration for the specified resources.
DescribeTopicsResult	describeTopics(java.util.Collection<java.lang.String> topicNames, DescribeTopicsOptions options) Describe some topics in the cluster.
ListTopicsResult	listTopics(ListTopicsOptions options) List the topics available in the cluster.

Methods inherited from class org.apache.kafka.clients.admin.AdminClient

alterConfigs, close, create, create, createAcls, createTopics, deleteAcls, deleteTopics, describeAcls, describeCluster, describeConfigs, describeTopics, listTopics

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

close

public void close(long duration,
         java.util.concurrent.TimeUnit unit)

Description copied from class: AdminClient

Close the AdminClient and release all associated resources. The close operation has a grace period during which current operations will be allowed to complete, specified by the given duration and time unit. New operations will not be accepted during the grace period. Once the grace period is over, all operations that have not yet been completed will be aborted with a TimeoutException.

Specified by:

close in class AdminClient

Parameters:

duration - The duration to use for the wait time.

unit - The time unit to use for the wait time.

createTopics

public CreateTopicsResult createTopics(java.util.Collection<NewTopic> newTopics,
                              CreateTopicsOptions options)

Description copied from class: AdminClient

Create a batch of new topics. It may take several seconds after AdminClient#createTopics returns success for all the brokers to become aware that the topics have been created. During this time, AdminClient#listTopics and AdminClient#describeTopics may not return information about the new topics. This operation is supported by brokers with version 0.10.1.0 or higher. The validateOnly option is supported from version 0.10.2.0.

Specified by:

createTopics in class AdminClient

Parameters:

newTopics - The new topics to create.

options - The options to use when creating the new topics.

Returns:

The CreateTopicsResult.

deleteTopics

public DeleteTopicsResult deleteTopics(java.util.Collection<java.lang.String> topicNames,
                              DeleteTopicsOptions options)

Description copied from class: AdminClient

Delete a batch of topics. It may take several seconds after AdminClient#deleteTopics returns success for all the brokers to become aware that the topics are gone. During this time, AdminClient#listTopics and AdminClient#describeTopics may continue to return information about the deleted topics. If delete.topic.enable is false on the brokers, deleteTopics will mark the topics for deletion, but not actually delete them. The futures will return successfully in this case. This operation is supported by brokers with version 0.10.1.0 or higher.

Specified by:

deleteTopics in class AdminClient

Parameters:

topicNames - The topic names to delete.

options - The options to use when deleting the topics.

Returns:

The DeleteTopicsResult.

listTopics

public ListTopicsResult listTopics(ListTopicsOptions options)

Description copied from class: AdminClient

List the topics available in the cluster.

Specified by:

listTopics in class AdminClient

Parameters:

options - The options to use when listing the topics.

Returns:

The ListTopicsResult.

describeTopics

public DescribeTopicsResult describeTopics(java.util.Collection<java.lang.String> topicNames,
                                  DescribeTopicsOptions options)

Description copied from class: AdminClient

Describe some topics in the cluster.

Specified by:

describeTopics in class AdminClient

Parameters:

topicNames - The names of the topics to describe.

options - The options to use when describing the topic.

Returns:

The DescribeTopicsResult.

describeCluster

public DescribeClusterResult describeCluster(DescribeClusterOptions options)

Description copied from class: AdminClient

Get information about the nodes in the cluster.

Specified by:

describeCluster in class AdminClient

Parameters:

options - The options to use when getting information about the cluster.

Returns:

The DescribeClusterResult.

describeAcls

public DescribeAclsResult describeAcls(AclBindingFilter filter,
                              DescribeAclsOptions options)

Description copied from class: AdminClient

Lists access control lists (ACLs) according to the supplied filter. Note: it may take some time for changes made by createAcls or deleteAcls to be reflected in the output of describeAcls. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

describeAcls in class AdminClient

Parameters:

filter - The filter to use.

options - The options to use when listing the ACLs.

Returns:

The DeleteAclsResult.

createAcls

public CreateAclsResult createAcls(java.util.Collection<AclBinding> acls,
                          CreateAclsOptions options)

Description copied from class: AdminClient

Creates access control lists (ACLs) which are bound to specific resources. If you attempt to add an ACL that duplicates an existing ACL, no error will be raised, but no changes will be made. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

createAcls in class AdminClient

Parameters:

acls - The ACLs to create

options - The options to use when creating the ACLs.

Returns:

The CreateAclsResult.

deleteAcls

public DeleteAclsResult deleteAcls(java.util.Collection<AclBindingFilter> filters,
                          DeleteAclsOptions options)

Description copied from class: AdminClient

Deletes access control lists (ACLs) according to the supplied filters. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

deleteAcls in class AdminClient

Parameters:

filters - The filters to use.

options - The options to use when deleting the ACLs.

Returns:

The DeleteAclsResult.

describeConfigs

public DescribeConfigsResult describeConfigs(java.util.Collection<ConfigResource> configResources,
                                    DescribeConfigsOptions options)

Description copied from class: AdminClient

Get the configuration for the specified resources. The returned configuration includes default values and the isDefault() method can be used to distinguish them from user supplied values. The value of config entries where isSensitive() is true is always null so that sensitive information is not disclosed. Config entries where isReadOnly() is true cannot be updated. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

describeConfigs in class AdminClient

Parameters:

configResources - The resources (topic and broker resource types are currently supported)

options - The options to use when describing configs

Returns:

The DescribeConfigsResult

alterConfigs

public AlterConfigsResult alterConfigs(java.util.Map<ConfigResource,Config> configs,
                              AlterConfigsOptions options)

Description copied from class: AdminClient

Update the configuration for the specified resources with the default options. Updates are not transactional so they may succeed for some resources while fail for others. The configs for a particular resource are updated atomically. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

alterConfigs in class AdminClient

Parameters:

configs - The resources with their configs (topic is the only resource type with configs that can be updated currently)

options - The options to use when describing configs

Returns:

The AlterConfigsResult