Admin (kafka 2.4.0 API)

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AdminClient, KafkaAdminClient
```
@InterfaceStability.Evolving
public interface Admin
extends AutoCloseable
```
The administrative client for Kafka, which supports managing and inspecting topics, brokers, configurations and ACLs.
The minimum broker version required is 0.10.0.0. Methods with stricter requirements will specify the minimum broker version required.
This client was introduced in 0.11.0.0 and the API is still evolving. We will try to evolve the API in a compatible manner, but we reserve the right to make breaking changes in minor releases, if necessary. We will update the InterfaceStability annotation and this notice once the API is considered stable.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default AlterConfigsResult`	`alterConfigs(Map<ConfigResource,Config> configs)` Deprecated. Since 2.3. Use `incrementalAlterConfigs(Map)`.
`AlterConfigsResult`	`alterConfigs(Map<ConfigResource,Config> configs, AlterConfigsOptions options)` Deprecated. Since 2.3. Use `incrementalAlterConfigs(Map, AlterConfigsOptions)`.
`default AlterPartitionReassignmentsResult`	`alterPartitionReassignments(Map<TopicPartition,Optional<NewPartitionReassignment>> reassignments)` Change the reassignments for one or more partitions.
`AlterPartitionReassignmentsResult`	`alterPartitionReassignments(Map<TopicPartition,Optional<NewPartitionReassignment>> reassignments, AlterPartitionReassignmentsOptions options)` Change the reassignments for one or more partitions.
`default AlterReplicaLogDirsResult`	`alterReplicaLogDirs(Map<TopicPartitionReplica,String> replicaAssignment)` Change the log directory for the specified replicas.
`AlterReplicaLogDirsResult`	`alterReplicaLogDirs(Map<TopicPartitionReplica,String> replicaAssignment, AlterReplicaLogDirsOptions options)` Change the log directory for the specified replicas.
`default void`	`close()` Close the Admin and release all associated resources.
`void`	`close(Duration timeout)` Close the Admin client and release all associated resources.
`default void`	`close(long duration, TimeUnit unit)` Deprecated. Since 2.2. Use `close(Duration)` or `close()`.
`static Admin`	`create(Map<String,Object> conf)` Create a new Admin with the given configuration.
`static Admin`	`create(Properties props)` Create a new Admin with the given configuration.
`default CreateAclsResult`	`createAcls(Collection<AclBinding> acls)` This is a convenience method for #`createAcls(Collection, CreateAclsOptions)` with default options.
`CreateAclsResult`	`createAcls(Collection<AclBinding> acls, CreateAclsOptions options)` Creates access control lists (ACLs) which are bound to specific resources.
`default CreateDelegationTokenResult`	`createDelegationToken()` Create a Delegation Token.
`CreateDelegationTokenResult`	`createDelegationToken(CreateDelegationTokenOptions options)` Create a Delegation Token.
`default CreatePartitionsResult`	`createPartitions(Map<String,NewPartitions> newPartitions)` Increase the number of partitions of the topics given as the keys of `newPartitions` according to the corresponding values.
`CreatePartitionsResult`	`createPartitions(Map<String,NewPartitions> newPartitions, CreatePartitionsOptions options)` Increase the number of partitions of the topics given as the keys of `newPartitions` according to the corresponding values.
`default CreateTopicsResult`	`createTopics(Collection<NewTopic> newTopics)` Create a batch of new topics with the default options.
`CreateTopicsResult`	`createTopics(Collection<NewTopic> newTopics, CreateTopicsOptions options)` Create a batch of new topics.
`default DeleteAclsResult`	`deleteAcls(Collection<AclBindingFilter> filters)` This is a convenience method for #`deleteAcls(Collection, DeleteAclsOptions)` with default options.
`DeleteAclsResult`	`deleteAcls(Collection<AclBindingFilter> filters, DeleteAclsOptions options)` Deletes access control lists (ACLs) according to the supplied filters.
`default DeleteConsumerGroupOffsetsResult`	`deleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions)` Delete committed offsets for a set of partitions in a consumer group with the default options.
`DeleteConsumerGroupOffsetsResult`	`deleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions, DeleteConsumerGroupOffsetsOptions options)` Delete committed offsets for a set of partitions in a consumer group.
`default DeleteConsumerGroupsResult`	`deleteConsumerGroups(Collection<String> groupIds)` Delete consumer groups from the cluster with the default options.
`DeleteConsumerGroupsResult`	`deleteConsumerGroups(Collection<String> groupIds, DeleteConsumerGroupsOptions options)` Delete consumer groups from the cluster.
`default DeleteRecordsResult`	`deleteRecords(Map<TopicPartition,RecordsToDelete> recordsToDelete)` Delete records whose offset is smaller than the given offset of the corresponding partition.
`DeleteRecordsResult`	`deleteRecords(Map<TopicPartition,RecordsToDelete> recordsToDelete, DeleteRecordsOptions options)` Delete records whose offset is smaller than the given offset of the corresponding partition.
`default DeleteTopicsResult`	`deleteTopics(Collection<String> topics)` This is a convenience method for #`deleteTopics(Collection, DeleteTopicsOptions)` with default options.
`DeleteTopicsResult`	`deleteTopics(Collection<String> topics, DeleteTopicsOptions options)` Delete a batch of topics.
`default DescribeAclsResult`	`describeAcls(AclBindingFilter filter)` This is a convenience method for #`describeAcls(AclBindingFilter, DescribeAclsOptions)` with default options.
`DescribeAclsResult`	`describeAcls(AclBindingFilter filter, DescribeAclsOptions options)` Lists access control lists (ACLs) according to the supplied filter.
`default DescribeClusterResult`	`describeCluster()` Get information about the nodes in the cluster, using the default options.
`DescribeClusterResult`	`describeCluster(DescribeClusterOptions options)` Get information about the nodes in the cluster.
`default DescribeConfigsResult`	`describeConfigs(Collection<ConfigResource> resources)` Get the configuration for the specified resources with the default options.
`DescribeConfigsResult`	`describeConfigs(Collection<ConfigResource> resources, DescribeConfigsOptions options)` Get the configuration for the specified resources.
`default DescribeConsumerGroupsResult`	`describeConsumerGroups(Collection<String> groupIds)` Describe some group IDs in the cluster, with the default options.
`DescribeConsumerGroupsResult`	`describeConsumerGroups(Collection<String> groupIds, DescribeConsumerGroupsOptions options)` Describe some group IDs in the cluster.
`default DescribeDelegationTokenResult`	`describeDelegationToken()` Describe the Delegation Tokens.
`DescribeDelegationTokenResult`	`describeDelegationToken(DescribeDelegationTokenOptions options)` Describe the Delegation Tokens.
`default DescribeLogDirsResult`	`describeLogDirs(Collection<Integer> brokers)` Query the information of all log directories on the given set of brokers
`DescribeLogDirsResult`	`describeLogDirs(Collection<Integer> brokers, DescribeLogDirsOptions options)` Query the information of all log directories on the given set of brokers
`default DescribeReplicaLogDirsResult`	`describeReplicaLogDirs(Collection<TopicPartitionReplica> replicas)` Query the replica log directory information for the specified replicas.
`DescribeReplicaLogDirsResult`	`describeReplicaLogDirs(Collection<TopicPartitionReplica> replicas, DescribeReplicaLogDirsOptions options)` Query the replica log directory information for the specified replicas.
`default DescribeTopicsResult`	`describeTopics(Collection<String> topicNames)` Describe some topics in the cluster, with the default options.
`DescribeTopicsResult`	`describeTopics(Collection<String> topicNames, DescribeTopicsOptions options)` Describe some topics in the cluster.
`default ElectLeadersResult`	`electLeaders(ElectionType electionType, Set<TopicPartition> partitions)` Elect a replica as leader for topic partitions.
`ElectLeadersResult`	`electLeaders(ElectionType electionType, Set<TopicPartition> partitions, ElectLeadersOptions options)` Elect a replica as leader for the given `partitions`, or for all partitions if the argumentl to `partitions` is null.
`default ElectPreferredLeadersResult`	`electPreferredLeaders(Collection<TopicPartition> partitions)` Deprecated. Since 2.4.0. Use `electLeaders(ElectionType, Set)`.
`default ElectPreferredLeadersResult`	`electPreferredLeaders(Collection<TopicPartition> partitions, ElectPreferredLeadersOptions options)` Deprecated. Since 2.4.0. Use `electLeaders(ElectionType, Set, ElectLeadersOptions)`.
`default ExpireDelegationTokenResult`	`expireDelegationToken(byte[] hmac)` Expire a Delegation Token.
`ExpireDelegationTokenResult`	`expireDelegationToken(byte[] hmac, ExpireDelegationTokenOptions options)` Expire a Delegation Token.
`default AlterConfigsResult`	`incrementalAlterConfigs(Map<ConfigResource,Collection<AlterConfigOp>> configs)` Incrementally updates the configuration for the specified resources with default options.
`AlterConfigsResult`	`incrementalAlterConfigs(Map<ConfigResource,Collection<AlterConfigOp>> configs, AlterConfigsOptions options)` Incrementally update the configuration for the specified resources.
`default ListConsumerGroupOffsetsResult`	`listConsumerGroupOffsets(String groupId)` List the consumer group offsets available in the cluster with the default options.
`ListConsumerGroupOffsetsResult`	`listConsumerGroupOffsets(String groupId, ListConsumerGroupOffsetsOptions options)` List the consumer group offsets available in the cluster.
`default ListConsumerGroupsResult`	`listConsumerGroups()` List the consumer groups available in the cluster with the default options.
`ListConsumerGroupsResult`	`listConsumerGroups(ListConsumerGroupsOptions options)` List the consumer groups available in the cluster.
`default ListPartitionReassignmentsResult`	`listPartitionReassignments()` List all of the current partition reassignments This is a convenience method for `listPartitionReassignments(ListPartitionReassignmentsOptions)` with default options.
`default ListPartitionReassignmentsResult`	`listPartitionReassignments(ListPartitionReassignmentsOptions options)` List all of the current partition reassignments
`ListPartitionReassignmentsResult`	`listPartitionReassignments(Optional<Set<TopicPartition>> partitions, ListPartitionReassignmentsOptions options)`
`default ListPartitionReassignmentsResult`	`listPartitionReassignments(Set<TopicPartition> partitions)` List the current reassignments for the given partitions This is a convenience method for `listPartitionReassignments(Set, ListPartitionReassignmentsOptions)` with default options.
`default ListPartitionReassignmentsResult`	`listPartitionReassignments(Set<TopicPartition> partitions, ListPartitionReassignmentsOptions options)` List the current reassignments for the given partitions
`default ListTopicsResult`	`listTopics()` List the topics available in the cluster with the default options.
`ListTopicsResult`	`listTopics(ListTopicsOptions options)` List the topics available in the cluster.
`Map<MetricName,? extends Metric>`	`metrics()` Get the metrics kept by the adminClient
`RemoveMembersFromConsumerGroupResult`	`removeMembersFromConsumerGroup(String groupId, RemoveMembersFromConsumerGroupOptions options)` Remove members from the consumer group by given member identities.
`default RenewDelegationTokenResult`	`renewDelegationToken(byte[] hmac)` Renew a Delegation Token.
`RenewDelegationTokenResult`	`renewDelegationToken(byte[] hmac, RenewDelegationTokenOptions options)` Renew a Delegation Token.

- Method Detail
  - create
```
static Admin create(Properties props)
```
    Create a new Admin with the given configuration.
    
    Parameters:
    
    props - The configuration.
    
    Returns:
    
    The new KafkaAdminClient.
  - create
```
static Admin create(Map<String,Object> conf)
```
    Create a new Admin with the given configuration.
    
    Parameters:
    
    conf - The configuration.
    
    Returns:
    
    The new KafkaAdminClient.
  - close
```
default void close()
```
    Close the Admin and release all associated resources.
    See close(long, TimeUnit)
    
    Specified by:
    
    close in interface AutoCloseable
  - close
```
@Deprecated
default void close(long duration,
                               TimeUnit unit)
```
    Deprecated. Since 2.2. Use close(Duration) or close().
    
    Close the Admin 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.
    
    Parameters:
    
    duration - The duration to use for the wait time.
    
    unit - The time unit to use for the wait time.
  - close
```
void close(Duration timeout)
```
    Close the Admin client 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. 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.
    
    Parameters:
    
    timeout - The time to use for the wait time.
  - createTopics
```
default CreateTopicsResult createTopics(Collection<NewTopic> newTopics)
```
    Create a batch of new topics with the default options.
    This is a convenience method for #createTopics(Collection, CreateTopicsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 0.10.1.0 or higher.
    
    Parameters:
    
    newTopics - The new topics to create.
    
    Returns:
    
    The CreateTopicsResult.
  - createTopics
```
CreateTopicsResult createTopics(Collection<NewTopic> newTopics,
                                CreateTopicsOptions options)
```
    Create a batch of new topics.
    This operation is not transactional so it may succeed for some topics while fail for others.
    It may take several seconds after CreateTopicsResult returns success for all the brokers to become aware that the topics have been created. During this time, listTopics() and describeTopics(Collection) 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.
    
    Parameters:
    
    newTopics - The new topics to create.
    
    options - The options to use when creating the new topics.
    
    Returns:
    
    The CreateTopicsResult.
  - deleteTopics
```
default DeleteTopicsResult deleteTopics(Collection<String> topics)
```
    This is a convenience method for #deleteTopics(Collection, DeleteTopicsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 0.10.1.0 or higher.
    
    Parameters:
    
    topics - The topic names to delete.
    
    Returns:
    
    The DeleteTopicsResult.
  - deleteTopics
```
DeleteTopicsResult deleteTopics(Collection<String> topics,
                                DeleteTopicsOptions options)
```
    Delete a batch of topics.
    This operation is not transactional so it may succeed for some topics while fail for others.
    It may take several seconds after the DeleteTopicsResult returns success for all the brokers to become aware that the topics are gone. During this time, Admin#listTopics and Admin#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.
    
    Parameters:
    
    topics - The topic names to delete.
    
    options - The options to use when deleting the topics.
    
    Returns:
    
    The DeleteTopicsResult.
  - listTopics
```
default ListTopicsResult listTopics()
```
    List the topics available in the cluster with the default options.
    This is a convenience method for #listTopics(ListTopicsOptions) with default options. See the overload for more details.
    
    Returns:
    
    The ListTopicsResult.
  - listTopics
```
ListTopicsResult listTopics(ListTopicsOptions options)
```
    List the topics available in the cluster.
    
    Parameters:
    
    options - The options to use when listing the topics.
    
    Returns:
    
    The ListTopicsResult.
  - describeTopics
```
default DescribeTopicsResult describeTopics(Collection<String> topicNames)
```
    Describe some topics in the cluster, with the default options.
    This is a convenience method for #describeTopics(Collection, DescribeTopicsOptions) with default options. See the overload for more details.
    
    Parameters:
    
    topicNames - The names of the topics to describe.
    
    Returns:
    
    The DescribeTopicsResult.
  - describeTopics
```
DescribeTopicsResult describeTopics(Collection<String> topicNames,
                                    DescribeTopicsOptions options)
```
    Describe some topics in the cluster.
    
    Parameters:
    
    topicNames - The names of the topics to describe.
    
    options - The options to use when describing the topic.
    
    Returns:
    
    The DescribeTopicsResult.
  - describeCluster
```
default DescribeClusterResult describeCluster()
```
    Get information about the nodes in the cluster, using the default options.
    This is a convenience method for #describeCluster(DescribeClusterOptions) with default options. See the overload for more details.
    
    Returns:
    
    The DescribeClusterResult.
  - describeCluster
```
DescribeClusterResult describeCluster(DescribeClusterOptions options)
```
    Get information about the nodes in the cluster.
    
    Parameters:
    
    options - The options to use when getting information about the cluster.
    
    Returns:
    
    The DescribeClusterResult.
  - describeAcls
```
default DescribeAclsResult describeAcls(AclBindingFilter filter)
```
    This is a convenience method for #describeAcls(AclBindingFilter, DescribeAclsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 0.11.0.0 or higher.
    
    Parameters:
    
    filter - The filter to use.
    
    Returns:
    
    The DeleteAclsResult.
  - describeAcls
```
DescribeAclsResult describeAcls(AclBindingFilter filter,
                                DescribeAclsOptions options)
```
    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.
    
    Parameters:
    
    filter - The filter to use.
    
    options - The options to use when listing the ACLs.
    
    Returns:
    
    The DeleteAclsResult.
  - createAcls
```
default CreateAclsResult createAcls(Collection<AclBinding> acls)
```
    This is a convenience method for #createAcls(Collection, CreateAclsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 0.11.0.0 or higher.
    
    Parameters:
    
    acls - The ACLs to create
    
    Returns:
    
    The CreateAclsResult.
  - createAcls
```
CreateAclsResult createAcls(Collection<AclBinding> acls,
                            CreateAclsOptions options)
```
    Creates access control lists (ACLs) which are bound to specific resources.
    This operation is not transactional so it may succeed for some ACLs while fail for others.
    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.
    
    Parameters:
    
    acls - The ACLs to create
    
    options - The options to use when creating the ACLs.
    
    Returns:
    
    The CreateAclsResult.
  - deleteAcls
```
default DeleteAclsResult deleteAcls(Collection<AclBindingFilter> filters)
```
    This is a convenience method for #deleteAcls(Collection, DeleteAclsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 0.11.0.0 or higher.
    
    Parameters:
    
    filters - The filters to use.
    
    Returns:
    
    The DeleteAclsResult.
  - deleteAcls
```
DeleteAclsResult deleteAcls(Collection<AclBindingFilter> filters,
                            DeleteAclsOptions options)
```
    Deletes access control lists (ACLs) according to the supplied filters.
    This operation is not transactional so it may succeed for some ACLs while fail for others.
    This operation is supported by brokers with version 0.11.0.0 or higher.
    
    Parameters:
    
    filters - The filters to use.
    
    options - The options to use when deleting the ACLs.
    
    Returns:
    
    The DeleteAclsResult.
  - describeConfigs
```
default DescribeConfigsResult describeConfigs(Collection<ConfigResource> resources)
```
    Get the configuration for the specified resources with the default options.
    This is a convenience method for #describeConfigs(Collection, DescribeConfigsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 0.11.0.0 or higher.
    
    Parameters:
    
    resources - The resources (topic and broker resource types are currently supported)
    
    Returns:
    
    The DescribeConfigsResult
  - describeConfigs
```
DescribeConfigsResult describeConfigs(Collection<ConfigResource> resources,
                                      DescribeConfigsOptions options)
```
    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.
    
    Parameters:
    
    resources - The resources (topic and broker resource types are currently supported)
    
    options - The options to use when describing configs
    
    Returns:
    
    The DescribeConfigsResult
  - alterConfigs
```
@Deprecated
default AlterConfigsResult alterConfigs(Map<ConfigResource,Config> configs)
```
    Deprecated. Since 2.3. Use incrementalAlterConfigs(Map).
    
    Update the configuration for the specified resources with the default options.
    This is a convenience method for #alterConfigs(Map, AlterConfigsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 0.11.0.0 or higher.
    
    Parameters:
    
    configs - The resources with their configs (topic is the only resource type with configs that can be updated currently)
    
    Returns:
    
    The AlterConfigsResult
  - alterConfigs
```
@Deprecated
AlterConfigsResult alterConfigs(Map<ConfigResource,Config> configs,
                                            AlterConfigsOptions options)
```
    Deprecated. Since 2.3. Use incrementalAlterConfigs(Map, AlterConfigsOptions).
    
    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.
    
    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
  - incrementalAlterConfigs
```
default AlterConfigsResult incrementalAlterConfigs(Map<ConfigResource,Collection<AlterConfigOp>> configs)
```
    Incrementally updates the configuration for the specified resources with default options.
    This is a convenience method for #incrementalAlterConfigs(Map, AlterConfigsOptions) with default options. See the overload for more details.*
    This operation is supported by brokers with version 2.3.0 or higher.
    
    Parameters:
    
    configs - The resources with their configs
    
    Returns:
    
    The IncrementalAlterConfigsResult
  - incrementalAlterConfigs
```
AlterConfigsResult incrementalAlterConfigs(Map<ConfigResource,Collection<AlterConfigOp>> configs,
                                           AlterConfigsOptions options)
```
    Incrementally update the configuration for the specified resources.
    Updates are not transactional so they may succeed for some resources while fail for others. The configs for a particular resource are updated atomically.
    The following exceptions can be anticipated when calling get() on the futures obtained from the returned IncrementalAlterConfigsResult:
    - ClusterAuthorizationException if the authenticated user didn't have alter access to the cluster.
    - TopicAuthorizationException if the authenticated user didn't have alter access to the Topic.
    - InvalidRequestException if the request details are invalid. e.g., a configuration key was specified more than once for a resource
    *
    This operation is supported by brokers with version 2.3.0 or higher.
    Parameters:
    
    configs - The resources with their configs
    
    options - The options to use when altering configs
    
    Returns:
    
    The IncrementalAlterConfigsResult
  - alterReplicaLogDirs
```
default AlterReplicaLogDirsResult alterReplicaLogDirs(Map<TopicPartitionReplica,String> replicaAssignment)
```
    Change the log directory for the specified replicas. If the replica does not exist on the broker, the result shows REPLICA_NOT_AVAILABLE for the given replica and the replica will be created in the given log directory on the broker when it is created later. If the replica already exists on the broker, the replica will be moved to the given log directory if it is not already there.
    This operation is not transactional so it may succeed for some replicas while fail for others.
    This is a convenience method for #alterReplicaLogDirs(Map, AlterReplicaLogDirsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 1.1.0 or higher.
    
    Parameters:
    
    replicaAssignment - The replicas with their log directory absolute path
    
    Returns:
    
    The AlterReplicaLogDirsResult
  - alterReplicaLogDirs
```
AlterReplicaLogDirsResult alterReplicaLogDirs(Map<TopicPartitionReplica,String> replicaAssignment,
                                              AlterReplicaLogDirsOptions options)
```
    Change the log directory for the specified replicas. If the replica does not exist on the broker, the result shows REPLICA_NOT_AVAILABLE for the given replica and the replica will be created in the given log directory on the broker when it is created later. If the replica already exists on the broker, the replica will be moved to the given log directory if it is not already there.
    This operation is not transactional so it may succeed for some replicas while fail for others.
    This operation is supported by brokers with version 1.1.0 or higher.
    
    Parameters:
    
    replicaAssignment - The replicas with their log directory absolute path
    
    options - The options to use when changing replica dir
    
    Returns:
    
    The AlterReplicaLogDirsResult
  - describeLogDirs
```
default DescribeLogDirsResult describeLogDirs(Collection<Integer> brokers)
```
    Query the information of all log directories on the given set of brokers
    This is a convenience method for #describeLogDirs(Collection, DescribeLogDirsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 1.0.0 or higher.
    
    Parameters:
    
    brokers - A list of brokers
    
    Returns:
    
    The DescribeLogDirsResult
  - describeLogDirs
```
DescribeLogDirsResult describeLogDirs(Collection<Integer> brokers,
                                      DescribeLogDirsOptions options)
```
    Query the information of all log directories on the given set of brokers
    This operation is supported by brokers with version 1.0.0 or higher.
    
    Parameters:
    
    brokers - A list of brokers
    
    options - The options to use when querying log dir info
    
    Returns:
    
    The DescribeLogDirsResult
  - describeReplicaLogDirs
```
default DescribeReplicaLogDirsResult describeReplicaLogDirs(Collection<TopicPartitionReplica> replicas)
```
    Query the replica log directory information for the specified replicas.
    This is a convenience method for #describeReplicaLogDirs(Collection, DescribeReplicaLogDirsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 1.0.0 or higher.
    
    Parameters:
    
    replicas - The replicas to query
    
    Returns:
    
    The DescribeReplicaLogDirsResult
  - describeReplicaLogDirs
```
DescribeReplicaLogDirsResult describeReplicaLogDirs(Collection<TopicPartitionReplica> replicas,
                                                    DescribeReplicaLogDirsOptions options)
```
    Query the replica log directory information for the specified replicas.
    This operation is supported by brokers with version 1.0.0 or higher.
    
    Parameters:
    
    replicas - The replicas to query
    
    options - The options to use when querying replica log dir info
    
    Returns:
    
    The DescribeReplicaLogDirsResult
  - createPartitions
```
default CreatePartitionsResult createPartitions(Map<String,NewPartitions> newPartitions)
```
    Increase the number of partitions of the topics given as the keys of newPartitions according to the corresponding values. If partitions are increased for a topic that has a key, the partition logic or ordering of the messages will be affected.
    
    This is a convenience method for createPartitions(Map, CreatePartitionsOptions) with default options. See the overload for more details.
    
    Parameters:
    
    newPartitions - The topics which should have new partitions created, and corresponding parameters for the created partitions.
    
    Returns:
    
    The CreatePartitionsResult.
  - createPartitions
```
CreatePartitionsResult createPartitions(Map<String,NewPartitions> newPartitions,
                                        CreatePartitionsOptions options)
```
    Increase the number of partitions of the topics given as the keys of newPartitions according to the corresponding values. If partitions are increased for a topic that has a key, the partition logic or ordering of the messages will be affected.
    
    This operation is not transactional so it may succeed for some topics while fail for others.
    
    It may take several seconds after this method returns success for all the brokers to become aware that the partitions have been created. During this time, describeTopics(Collection) may not return information about the new partitions.
    
    This operation is supported by brokers with version 1.0.0 or higher.
    
    The following exceptions can be anticipated when calling get() on the futures obtained from the values() method of the returned CreatePartitionsResult
    - AuthorizationException if the authenticated user is not authorized to alter the topic
    - TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().
    - ReassignmentInProgressException if a partition reassignment is currently in progress
    - BrokerNotAvailableException if the requested NewPartitions.assignments() contain a broker that is currently unavailable.
    - InvalidReplicationFactorException if no NewPartitions.assignments() are given and it is impossible for the broker to assign replicas with the topics replication factor.
    - Subclasses of KafkaException if the request is invalid in some way.
    Parameters:
    
    newPartitions - The topics which should have new partitions created, and corresponding parameters for the created partitions.
    
    options - The options to use when creating the new paritions.
    
    Returns:
    
    The CreatePartitionsResult.
  - deleteRecords
```
default DeleteRecordsResult deleteRecords(Map<TopicPartition,RecordsToDelete> recordsToDelete)
```
    Delete records whose offset is smaller than the given offset of the corresponding partition.
    This is a convenience method for deleteRecords(Map, DeleteRecordsOptions) with default options. See the overload for more details.
    This operation is supported by brokers with version 0.11.0.0 or higher.
    
    Parameters:
    
    recordsToDelete - The topic partitions and related offsets from which records deletion starts.
    
    Returns:
    
    The DeleteRecordsResult.
  - deleteRecords
```
DeleteRecordsResult deleteRecords(Map<TopicPartition,RecordsToDelete> recordsToDelete,
                                  DeleteRecordsOptions options)
```
    Delete records whose offset is smaller than the given offset of the corresponding partition.
    This operation is supported by brokers with version 0.11.0.0 or higher.
    
    Parameters:
    
    recordsToDelete - The topic partitions and related offsets from which records deletion starts.
    
    options - The options to use when deleting records.
    
    Returns:
    
    The DeleteRecordsResult.
  - createDelegationToken
```
default CreateDelegationTokenResult createDelegationToken()
```
    Create a Delegation Token.
    
    This is a convenience method for createDelegationToken(CreateDelegationTokenOptions) with default options. See the overload for more details.
    
    Returns:
    
    The CreateDelegationTokenResult.
  - createDelegationToken
```
CreateDelegationTokenResult createDelegationToken(CreateDelegationTokenOptions options)
```
    Create a Delegation Token.
    
    This operation is supported by brokers with version 1.1.0 or higher.
    
    The following exceptions can be anticipated when calling get() on the futures obtained from the delegationToken() method of the returned CreateDelegationTokenResult
    - UnsupportedByAuthenticationException If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.
    - InvalidPrincipalTypeException if the renewers principal type is not supported.
    - DelegationTokenDisabledException if the delegation token feature is disabled.
    - TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().
    Parameters:
    
    options - The options to use when creating delegation token.
    
    Returns:
    
    The DeleteRecordsResult.
  - renewDelegationToken
```
default RenewDelegationTokenResult renewDelegationToken(byte[] hmac)
```
    Renew a Delegation Token.
    
    This is a convenience method for renewDelegationToken(byte[], RenewDelegationTokenOptions) with default options. See the overload for more details.
    
    Parameters:
    
    hmac - HMAC of the Delegation token
    
    Returns:
    
    The RenewDelegationTokenResult.
  - renewDelegationToken
```
RenewDelegationTokenResult renewDelegationToken(byte[] hmac,
                                                RenewDelegationTokenOptions options)
```
    Renew a Delegation Token.
    
    This operation is supported by brokers with version 1.1.0 or higher.
    
    The following exceptions can be anticipated when calling get() on the futures obtained from the expiryTimestamp() method of the returned RenewDelegationTokenResult
    - UnsupportedByAuthenticationException If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.
    - DelegationTokenDisabledException if the delegation token feature is disabled.
    - DelegationTokenNotFoundException if the delegation token is not found on server.
    - DelegationTokenOwnerMismatchException if the authenticated user is not owner/renewer of the token.
    - DelegationTokenExpiredException if the delegation token is expired.
    - TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().
    Parameters:
    
    hmac - HMAC of the Delegation token
    
    options - The options to use when renewing delegation token.
    
    Returns:
    
    The RenewDelegationTokenResult.
  - expireDelegationToken
```
default ExpireDelegationTokenResult expireDelegationToken(byte[] hmac)
```
    Expire a Delegation Token.
    
    This is a convenience method for expireDelegationToken(byte[], ExpireDelegationTokenOptions) with default options. This will expire the token immediately. See the overload for more details.
    
    Parameters:
    
    hmac - HMAC of the Delegation token
    
    Returns:
    
    The ExpireDelegationTokenResult.
  - expireDelegationToken
```
ExpireDelegationTokenResult expireDelegationToken(byte[] hmac,
                                                  ExpireDelegationTokenOptions options)
```
    Expire a Delegation Token.
    
    This operation is supported by brokers with version 1.1.0 or higher.
    
    The following exceptions can be anticipated when calling get() on the futures obtained from the expiryTimestamp() method of the returned ExpireDelegationTokenResult
    - UnsupportedByAuthenticationException If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.
    - DelegationTokenDisabledException if the delegation token feature is disabled.
    - DelegationTokenNotFoundException if the delegation token is not found on server.
    - DelegationTokenOwnerMismatchException if the authenticated user is not owner/renewer of the requested token.
    - DelegationTokenExpiredException if the delegation token is expired.
    - TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().
    Parameters:
    
    hmac - HMAC of the Delegation token
    
    options - The options to use when expiring delegation token.
    
    Returns:
    
    The ExpireDelegationTokenResult.
  - describeDelegationToken
```
default DescribeDelegationTokenResult describeDelegationToken()
```
    Describe the Delegation Tokens.
    
    This is a convenience method for describeDelegationToken(DescribeDelegationTokenOptions) with default options. This will return all the user owned tokens and tokens where user have Describe permission. See the overload for more details.
    
    Returns:
    
    The DescribeDelegationTokenResult.
  - describeDelegationToken
```
DescribeDelegationTokenResult describeDelegationToken(DescribeDelegationTokenOptions options)
```
    Describe the Delegation Tokens.
    
    This operation is supported by brokers with version 1.1.0 or higher.
    
    The following exceptions can be anticipated when calling get() on the futures obtained from the delegationTokens() method of the returned DescribeDelegationTokenResult
    - UnsupportedByAuthenticationException If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.
    - DelegationTokenDisabledException if the delegation token feature is disabled.
    - TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().
    Parameters:
    
    options - The options to use when describing delegation tokens.
    
    Returns:
    
    The DescribeDelegationTokenResult.
  - describeConsumerGroups
```
DescribeConsumerGroupsResult describeConsumerGroups(Collection<String> groupIds,
                                                    DescribeConsumerGroupsOptions options)
```
    Describe some group IDs in the cluster.
    
    Parameters:
    
    groupIds - The IDs of the groups to describe.
    
    options - The options to use when describing the groups.
    
    Returns:
    
    The DescribeConsumerGroupResult.
  - describeConsumerGroups
```
default DescribeConsumerGroupsResult describeConsumerGroups(Collection<String> groupIds)
```
    Describe some group IDs in the cluster, with the default options.
    This is a convenience method for #describeConsumerGroups(Collection, DescribeConsumerGroupsOptions) with default options. See the overload for more details.
    
    Parameters:
    
    groupIds - The IDs of the groups to describe.
    
    Returns:
    
    The DescribeConsumerGroupResult.
  - listConsumerGroups
```
ListConsumerGroupsResult listConsumerGroups(ListConsumerGroupsOptions options)
```
    List the consumer groups available in the cluster.
    
    Parameters:
    
    options - The options to use when listing the consumer groups.
    
    Returns:
    
    The ListGroupsResult.
  - listConsumerGroups
```
default ListConsumerGroupsResult listConsumerGroups()
```
    List the consumer groups available in the cluster with the default options.
    This is a convenience method for #listConsumerGroups(ListConsumerGroupsOptions) with default options. See the overload for more details.
    
    Returns:
    
    The ListGroupsResult.
  - listConsumerGroupOffsets
```
ListConsumerGroupOffsetsResult listConsumerGroupOffsets(String groupId,
                                                        ListConsumerGroupOffsetsOptions options)
```
    List the consumer group offsets available in the cluster.
    
    Parameters:
    
    options - The options to use when listing the consumer group offsets.
    
    Returns:
    
    The ListGroupOffsetsResult
  - listConsumerGroupOffsets
```
default ListConsumerGroupOffsetsResult listConsumerGroupOffsets(String groupId)
```
    List the consumer group offsets available in the cluster with the default options.
    This is a convenience method for #listConsumerGroupOffsets(String, ListConsumerGroupOffsetsOptions) with default options.
    
    Returns:
    
    The ListGroupOffsetsResult.
  - deleteConsumerGroups
```
DeleteConsumerGroupsResult deleteConsumerGroups(Collection<String> groupIds,
                                                DeleteConsumerGroupsOptions options)
```
    Delete consumer groups from the cluster.
    
    Parameters:
    
    options - The options to use when deleting a consumer group.
    
    Returns:
    
    The DeletConsumerGroupResult.
  - deleteConsumerGroups
```
default DeleteConsumerGroupsResult deleteConsumerGroups(Collection<String> groupIds)
```
    Delete consumer groups from the cluster with the default options.
    
    Returns:
    
    The DeleteConsumerGroupResult.
  - deleteConsumerGroupOffsets
```
DeleteConsumerGroupOffsetsResult deleteConsumerGroupOffsets(String groupId,
                                                            Set<TopicPartition> partitions,
                                                            DeleteConsumerGroupOffsetsOptions options)
```
    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:
    
    options - The options to use when deleting offsets in a consumer group.
    
    Returns:
    
    The DeleteConsumerGroupOffsetsResult.
  - deleteConsumerGroupOffsets
```
default DeleteConsumerGroupOffsetsResult deleteConsumerGroupOffsets(String groupId,
                                                                    Set<TopicPartition> partitions)
```
    Delete committed offsets for a set of partitions in a consumer group with the default options. This will succeed at the partition level only if the group is not actively subscribed to the corresponding topic.
    
    Returns:
    
    The DeleteConsumerGroupOffsetsResult.
  - electPreferredLeaders
```
@Deprecated
default ElectPreferredLeadersResult electPreferredLeaders(Collection<TopicPartition> partitions)
```
    Deprecated. Since 2.4.0. Use electLeaders(ElectionType, Set).
    
    Elect the preferred replica as leader for topic partitions.
    This is a convenience method for electLeaders(ElectionType, Set, ElectLeadersOptions) with preferred election type and default options.
    This operation is supported by brokers with version 2.2.0 or higher.
    
    Parameters:
    
    partitions - The partitions for which the preferred leader should be elected.
    
    Returns:
    
    The ElectPreferredLeadersResult.
  - electPreferredLeaders
```
@Deprecated
default ElectPreferredLeadersResult electPreferredLeaders(Collection<TopicPartition> partitions,
                                                                      ElectPreferredLeadersOptions options)
```
    Deprecated. Since 2.4.0. Use electLeaders(ElectionType, Set, ElectLeadersOptions).
    
    Elect the preferred replica as leader for topic partitions.
    This is a convenience method for electLeaders(ElectionType, Set, ElectLeadersOptions) with preferred election type.
    This operation is supported by brokers with version 2.2.0 or higher.
    
    Parameters:
    
    partitions - The partitions for which the preferred leader should be elected.
    
    options - The options to use when electing the preferred leaders.
    
    Returns:
    
    The ElectPreferredLeadersResult.
  - electLeaders
```
default ElectLeadersResult electLeaders(ElectionType electionType,
                                        Set<TopicPartition> partitions)
```
    Elect a replica as leader for topic partitions.
    This is a convenience method for electLeaders(ElectionType, Set, ElectLeadersOptions) with default options.
    
    Parameters:
    
    electionType - The type of election to conduct.
    
    partitions - The topics and partitions for which to conduct elections.
    
    Returns:
    
    The ElectLeadersResult.
  - electLeaders
```
ElectLeadersResult electLeaders(ElectionType electionType,
                                Set<TopicPartition> partitions,
                                ElectLeadersOptions options)
```
    Elect a replica as leader for the given partitions, or for all partitions if the argumentl to partitions is null.
    This operation is not transactional so it may succeed for some partitions while fail for others.
    It may take several seconds after this method returns success for all the brokers in the cluster to become aware that the partitions have new leaders. During this time, describeTopics(Collection) may not return information about the partitions' new leaders.
    This operation is supported by brokers with version 2.2.0 or later if preferred eleciton is use; otherwise the brokers most be 2.4.0 or higher.
    The following exceptions can be anticipated when calling get() on the future obtained from the returned ElectLeadersResult:
    - ClusterAuthorizationException if the authenticated user didn't have alter access to the cluster.
    - UnknownTopicOrPartitionException if the topic or partition did not exist within the cluster.
    - InvalidTopicException if the topic was already queued for deletion.
    - NotControllerException if the request was sent to a broker that was not the controller for the cluster.
    - TimeoutException if the request timed out before the election was complete.
    - LeaderNotAvailableException if the preferred leader was not alive or not in the ISR.
    Parameters:
    
    electionType - The type of election to conduct.
    
    partitions - The topics and partitions for which to conduct elections.
    
    options - The options to use when electing the leaders.
    
    Returns:
    
    The ElectLeadersResult.
  - alterPartitionReassignments
```
default AlterPartitionReassignmentsResult alterPartitionReassignments(Map<TopicPartition,Optional<NewPartitionReassignment>> reassignments)
```
    Change the reassignments for one or more partitions. Providing an empty Optional (e.g via Optional.empty()) will revert the reassignment for the associated partition. This is a convenience method for alterPartitionReassignments(Map, AlterPartitionReassignmentsOptions) with default options. See the overload for more details.
  - alterPartitionReassignments
```
AlterPartitionReassignmentsResult alterPartitionReassignments(Map<TopicPartition,Optional<NewPartitionReassignment>> reassignments,
                                                              AlterPartitionReassignmentsOptions options)
```
    Change the reassignments for one or more partitions. Providing an empty Optional (e.g via Optional.empty()) will revert the reassignment for the associated partition.
    The following exceptions can be anticipated when calling get() on the futures obtained from the returned AlterPartitionReassignmentsResult:
    - ClusterAuthorizationException If the authenticated user didn't have alter access to the cluster.
    - UnknownTopicOrPartitionException If the topic or partition does not exist within the cluster.
    - TimeoutException if the request timed out before the controller could record the new assignments.
    - InvalidReplicaAssignmentException If the specified assignment was not valid.
    - NoReassignmentInProgressException If there was an attempt to cancel a reassignment for a partition which was not being reassigned.
    Parameters:
    
    reassignments - The reassignments to add, modify, or remove.
    
    options - The options to use.
    
    Returns:
    
    The result.
  - listPartitionReassignments
```
default ListPartitionReassignmentsResult listPartitionReassignments()
```
    List all of the current partition reassignments This is a convenience method for listPartitionReassignments(ListPartitionReassignmentsOptions) with default options. See the overload for more details.
  - listPartitionReassignments
```
default ListPartitionReassignmentsResult listPartitionReassignments(Set<TopicPartition> partitions)
```
    List the current reassignments for the given partitions This is a convenience method for listPartitionReassignments(Set, ListPartitionReassignmentsOptions) with default options. See the overload for more details.
  - listPartitionReassignments
```
default ListPartitionReassignmentsResult listPartitionReassignments(Set<TopicPartition> partitions,
                                                                    ListPartitionReassignmentsOptions options)
```
    List the current reassignments for the given partitions
    The following exceptions can be anticipated when calling get() on the futures obtained from the returned ListPartitionReassignmentsResult:
    - ClusterAuthorizationException If the authenticated user doesn't have alter access to the cluster.
    - UnknownTopicOrPartitionException If a given topic or partition does not exist.
    - TimeoutException If the request timed out before the controller could list the current reassignments.
    Parameters:
    
    partitions - The topic partitions to list reassignments for.
    
    options - The options to use.
    
    Returns:
    
    The result.
  - listPartitionReassignments
```
default ListPartitionReassignmentsResult listPartitionReassignments(ListPartitionReassignmentsOptions options)
```
    List all of the current partition reassignments
    The following exceptions can be anticipated when calling get() on the futures obtained from the returned ListPartitionReassignmentsResult:
    - ClusterAuthorizationException If the authenticated user doesn't have alter access to the cluster.
    - UnknownTopicOrPartitionException If a given topic or partition does not exist.
    - TimeoutException If the request timed out before the controller could list the current reassignments.
    Parameters:
    
    options - The options to use.
    
    Returns:
    
    The result.
  - listPartitionReassignments
```
ListPartitionReassignmentsResult listPartitionReassignments(Optional<Set<TopicPartition>> partitions,
                                                            ListPartitionReassignmentsOptions options)
```
    Parameters:
    
    partitions - the partitions we want to get reassignment for, or an empty optional if we want to get the reassignments for all partitions in the cluster
    
    options - The options to use.
    
    Returns:
    
    The result.
  - removeMembersFromConsumerGroup
```
RemoveMembersFromConsumerGroupResult removeMembersFromConsumerGroup(String groupId,
                                                                    RemoveMembersFromConsumerGroupOptions options)
```
    Remove members from the consumer group by given member identities.
    For possible error codes, refer to LeaveGroupResponse.
    
    Parameters:
    
    groupId - The ID of the group to remove member from.
    
    options - The options to carry removing members' information.
    
    Returns:
    
    The MembershipChangeResult.
  - metrics
```
Map<MetricName,? extends Metric> metrics()
```
    Get the metrics kept by the adminClient

Interface Admin

Method Summary

Method Detail

create

create

close

close

close

createTopics

createTopics

deleteTopics

deleteTopics

listTopics

listTopics

describeTopics

describeTopics

describeCluster

describeCluster

describeAcls

describeAcls

createAcls

createAcls

deleteAcls

deleteAcls

describeConfigs

describeConfigs

alterConfigs

alterConfigs

incrementalAlterConfigs

incrementalAlterConfigs

alterReplicaLogDirs

alterReplicaLogDirs

describeLogDirs

describeLogDirs

describeReplicaLogDirs

describeReplicaLogDirs

createPartitions

createPartitions

deleteRecords

deleteRecords

createDelegationToken

createDelegationToken

renewDelegationToken

renewDelegationToken

expireDelegationToken

expireDelegationToken

describeDelegationToken

describeDelegationToken

describeConsumerGroups

describeConsumerGroups

listConsumerGroups

listConsumerGroups

listConsumerGroupOffsets

listConsumerGroupOffsets

deleteConsumerGroups

deleteConsumerGroups

deleteConsumerGroupOffsets

deleteConsumerGroupOffsets

electPreferredLeaders

electPreferredLeaders

electLeaders

electLeaders

alterPartitionReassignments

alterPartitionReassignments

listPartitionReassignments

listPartitionReassignments

listPartitionReassignments

listPartitionReassignments

listPartitionReassignments

removeMembersFromConsumerGroup

metrics