Package org.apache.kafka.clients.admin
package org.apache.kafka.clients.admin
Provides a Kafka client for performing administrative operations (such as creating topics and configuring brokers) on a Kafka cluster.
-
ClassDescriptionAbstractOptions<T extends AbstractOptions>The administrative client for Kafka, which supports managing and inspecting topics, brokers, configurations and ACLs.The base class for in-built admin clients.The AdminClient configuration class, which also contains constants for configuration entry names.The result of the
Admin.alterClientQuotas(Collection, AlterClientQuotasOptions)
call.A class representing a alter configuration entry containing name, value and operation type.Options forAdmin.incrementalAlterConfigs(Map)
andAdmin.alterConfigs(Map)
.The result of theAdmin.alterConfigs(Map)
call.Options for theAdmin.alterConsumerGroupOffsets(String, Map, AlterConsumerGroupOffsetsOptions)
call.The result of theAdmin.alterConsumerGroupOffsets(String, Map)
call.Options forAdmin.alterPartitionReassignments(Map, AlterPartitionReassignmentsOptions)
The API of this class is evolving.The result ofAdmin.alterReplicaLogDirs(Map, AlterReplicaLogDirsOptions)
.Options forAdmin.alterUserScramCredentials(List, AlterUserScramCredentialsOptions)
The API of this class is evolving.The result of theAdmin.alterUserScramCredentials(List)
call.A configuration object containing the configuration entries for a resource.A class representing a configuration entry containing name, value and additional metadata.Source of configuration entries.Class representing a configuration synonym of aConfigEntry
.Data type of configuration entry.A detailed description of a single consumer group in the cluster.A listing of a consumer group in the cluster.Options forAdmin.createAcls(Collection)
.The result of theAdmin.createAcls(Collection)
call.The result of theKafkaAdminClient.createDelegationToken(CreateDelegationTokenOptions)
call.Options forAdmin.createPartitions(Map)
.The result of theAdmin.createPartitions(Map)
call.Options forAdmin.createTopics(Collection)
.The result ofAdmin.createTopics(Collection)
.Options for theAdmin.deleteAcls(Collection)
call.The result of theAdmin.deleteAcls(Collection)
call.A class containing either the deleted ACL binding or an exception if the delete failed.A class containing the results of the delete ACLs operation.Options for theAdmin.deleteConsumerGroupOffsets(String, Set)
call.The result of theAdmin.deleteConsumerGroupOffsets(String, Set)
call.Options for theAdmin.deleteConsumerGroups(Collection)
call.The result of theAdmin.deleteConsumerGroups(Collection)
call.Represents information about deleted records The API for this class is still evolving and we may break compatibility in minor releases, if necessary.Options forAdmin.deleteRecords(Map, DeleteRecordsOptions)
.The result of theAdmin.deleteRecords(Map)
call.Options forAdmin.deleteTopics(Collection)
.The result of theAdmin.deleteTopics(Collection)
call.Options forAdmin.describeAcls(AclBindingFilter)
.The result of theAdmin.describeAcls(AclBindingFilter)
call.The result of theAdmin.describeClientQuotas(ClientQuotaFilter, DescribeClientQuotasOptions)
call.Options forAdmin.describeCluster()
.The result of theAdmin.describeCluster()
call.Options forAdmin.describeConfigs(Collection)
.The result of theAdmin.describeConfigs(Collection)
call.The result of theKafkaAdminClient.describeConsumerGroups(Collection, DescribeConsumerGroupsOptions)
} call.The result of theKafkaAdminClient.describeDelegationToken(DescribeDelegationTokenOptions)
call.Options forAdmin.describeFeatures(DescribeFeaturesOptions)
.The result of theAdmin.describeFeatures(DescribeFeaturesOptions)
call.Options forAdmin.describeLogDirs(Collection)
The API of this class is evolving, seeAdmin
for details.The result of theAdmin.describeLogDirs(Collection)
call.Options forAdmin.describeProducers(Collection)
.Options forAdmin.describeReplicaLogDirs(Collection)
.The result ofAdmin.describeReplicaLogDirs(Collection)
.Options forAdmin.describeTopics(Collection)
.The result of theAdmin.describeTopics(Collection)
call.Options forAdmin.describeTransactions(Collection)
.Options forAdmin.describeUserScramCredentials(List, DescribeUserScramCredentialsOptions)
The API of this class is evolving.The result of theAdmin.describeUserScramCredentials()
call.The result ofAdmin.electLeaders(ElectionType, Set, ElectLeadersOptions)
The API of this class is evolving, seeAdmin
for details.The result of theKafkaAdminClient.expireDelegationToken(byte[], ExpireDelegationTokenOptions)
call.Encapsulates details about finalized as well as supported features.Encapsulates details about an update to a finalized feature.Options forAdmin.fenceProducers(Collection, FenceProducersOptions)
The API of this class is evolving.The result of theAdmin.fenceProducers(Collection)
call.Represents a range of version levels supported by every broker in a cluster for some feature.ForwardingAdmin
is the default value offorwarding.admin.class
in MirrorMaker.The default implementation ofAdmin
.The result of theAdmin.listConsumerGroupOffsets(Map)
andAdmin.listConsumerGroupOffsets(String)
call.Specification of consumer group offsets to list usingAdmin.listConsumerGroupOffsets(java.util.Map)
.Options forAdmin.listConsumerGroups()
.The result of theAdmin.listConsumerGroups()
call.Options forAdmin.listOffsets(Map)
.The result of theAdmin.listOffsets(Map)
call.Options forAdmin.listPartitionReassignments(ListPartitionReassignmentsOptions)
The API of this class is evolving.Options forAdmin.listTopics()
.The result of theAdmin.listTopics()
call.Options forAdmin.listTransactions()
.The result of theAdmin.listTransactions()
call.A description of a log directory on a particular broker.A description of the assignments of a specific group member.A detailed description of a single group instance in the cluster.A struct containing information about the member to be removed.A new partition reassignment, which can be applied viaAdmin.alterPartitionReassignments(Map, AlterPartitionReassignmentsOptions)
.Describes new partitions for a particular topic in a call toAdmin.createPartitions(Map)
.A new topic to be created viaAdmin.createTopics(Collection)
.This class allows to specify the desired offsets when usingKafkaAdminClient.listOffsets(Map, ListOffsetsOptions)
A partition reassignment, which has been listed viaAdmin.listPartitionReassignments()
.This class is used to describe the state of the quorum received in DescribeQuorumResponse.Describe records to delete in a call toAdmin.deleteRecords(Map)
The API of this class is evolving, seeAdmin
for details.The result of theAdmin.removeMembersFromConsumerGroup(String, RemoveMembersFromConsumerGroupOptions)
call.The result of theKafkaAdminClient.expireDelegationToken(byte[], ExpireDelegationTokenOptions)
call.A description of a replica on a particular broker.Mechanism and iterations for a SASL/SCRAM credential associated with a user.Representation of a SASL/SCRAM Mechanism.Represents a range of versions that a particular broker supports for some feature.A detailed description of a single topic in the cluster.A listing of a topic in the cluster.Options forAdmin.unregisterBroker(int, UnregisterBrokerOptions)
.The result of theAdmin.unregisterBroker(int, UnregisterBrokerOptions)
call.Options forAdmin.updateFeatures(Map, UpdateFeaturesOptions)
.The result of theAdmin.updateFeatures(Map, UpdateFeaturesOptions)
call.A request to alter a user's SASL/SCRAM credentials.A request to delete a SASL/SCRAM credential for a user.Representation of all SASL/SCRAM credentials associated with a user that can be retrieved, or an exception indicating why credentials could not be retrieved.A request to update/insert a SASL/SCRAM credential for a user.