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.

Interface Summary

Interface	Description
Admin	The administrative client for Kafka, which supports managing and inspecting topics, brokers, configurations and ACLs.

Class Summary

Class	Description
AbortTransactionOptions
AbortTransactionResult	The result of Admin.abortTransaction(AbortTransactionSpec, AbortTransactionOptions).
AbortTransactionSpec
AbstractOptions<T extends AbstractOptions>
AdminClient	The base class for in-built admin clients.
AdminClientConfig	The AdminClient configuration class, which also contains constants for configuration entry names.
AlterClientQuotasOptions	Options for Admin.alterClientQuotas(Collection, AlterClientQuotasOptions).
AlterClientQuotasResult	The result of the Admin.alterClientQuotas(Collection, AlterClientQuotasOptions) call.
AlterConfigOp	A class representing a alter configuration entry containing name, value and operation type.
AlterConfigsOptions	Options for Admin.incrementalAlterConfigs(Map) and Admin.alterConfigs(Map).
AlterConfigsResult	The result of the Admin.alterConfigs(Map) call.
AlterConsumerGroupOffsetsOptions	Options for the Admin.alterConsumerGroupOffsets(String, Map, AlterConsumerGroupOffsetsOptions) call.
AlterConsumerGroupOffsetsResult	The result of the Admin.alterConsumerGroupOffsets(String, Map) call.
AlterPartitionReassignmentsOptions	Options for Admin.alterPartitionReassignments(Map, AlterPartitionReassignmentsOptions) The API of this class is evolving.
AlterPartitionReassignmentsResult	The result of Admin.alterPartitionReassignments(Map, AlterPartitionReassignmentsOptions).
AlterReplicaLogDirsOptions	Options for Admin.alterReplicaLogDirs(Map, AlterReplicaLogDirsOptions).
AlterReplicaLogDirsResult	The result of Admin.alterReplicaLogDirs(Map, AlterReplicaLogDirsOptions).
AlterUserScramCredentialsOptions	Options for Admin.alterUserScramCredentials(List, AlterUserScramCredentialsOptions) The API of this class is evolving.
AlterUserScramCredentialsResult	The result of the Admin.alterUserScramCredentials(List) call.
Config	A configuration object containing the configuration entries for a resource.
ConfigEntry	A class representing a configuration entry containing name, value and additional metadata.
ConfigEntry.ConfigSynonym	Class representing a configuration synonym of a ConfigEntry.
ConsumerGroupDescription	A detailed description of a single consumer group in the cluster.
ConsumerGroupListing	A listing of a consumer group in the cluster.
CreateAclsOptions	Options for Admin.createAcls(Collection).
CreateAclsResult	The result of the Admin.createAcls(Collection) call.
CreateDelegationTokenOptions	Options for Admin.createDelegationToken(CreateDelegationTokenOptions).
CreateDelegationTokenResult	The result of the KafkaAdminClient.createDelegationToken(CreateDelegationTokenOptions) call.
CreatePartitionsOptions	Options for Admin.createPartitions(Map).
CreatePartitionsResult	The result of the Admin.createPartitions(Map) call.
CreateTopicsOptions	Options for Admin.createTopics(Collection).
CreateTopicsResult	The result of Admin.createTopics(Collection).
CreateTopicsResult.TopicMetadataAndConfig
DeleteAclsOptions	Options for the Admin.deleteAcls(Collection) call.
DeleteAclsResult	The result of the Admin.deleteAcls(Collection) call.
DeleteAclsResult.FilterResult	A class containing either the deleted ACL binding or an exception if the delete failed.
DeleteAclsResult.FilterResults	A class containing the results of the delete ACLs operation.
DeleteConsumerGroupOffsetsOptions	Options for the Admin.deleteConsumerGroupOffsets(String, Set) call.
DeleteConsumerGroupOffsetsResult	The result of the Admin.deleteConsumerGroupOffsets(String, Set) call.
DeleteConsumerGroupsOptions	Options for the Admin.deleteConsumerGroups(Collection) call.
DeleteConsumerGroupsResult	The result of the Admin.deleteConsumerGroups(Collection) call.
DeletedRecords	Represents information about deleted records The API for this class is still evolving and we may break compatibility in minor releases, if necessary.
DeleteRecordsOptions	Options for Admin.deleteRecords(Map, DeleteRecordsOptions).
DeleteRecordsResult	The result of the Admin.deleteRecords(Map) call.
DeleteTopicsOptions	Options for Admin.deleteTopics(Collection).
DeleteTopicsResult	The result of the Admin.deleteTopics(Collection) call.
DescribeAclsOptions	Options for Admin.describeAcls(AclBindingFilter).
DescribeAclsResult	The result of the Admin.describeAcls(AclBindingFilter) call.
DescribeClientQuotasOptions	Options for Admin.describeClientQuotas(ClientQuotaFilter, DescribeClientQuotasOptions).
DescribeClientQuotasResult	The result of the Admin.describeClientQuotas(ClientQuotaFilter, DescribeClientQuotasOptions) call.
DescribeClusterOptions	Options for Admin.describeCluster().
DescribeClusterResult	The result of the Admin.describeCluster() call.
DescribeConfigsOptions	Options for Admin.describeConfigs(Collection).
DescribeConfigsResult	The result of the Admin.describeConfigs(Collection) call.
DescribeConsumerGroupsOptions	Options for Admin.describeConsumerGroups(Collection, DescribeConsumerGroupsOptions).
DescribeConsumerGroupsResult	The result of the KafkaAdminClient.describeConsumerGroups(Collection, DescribeConsumerGroupsOptions)} call.
DescribeDelegationTokenOptions	Options for Admin.describeDelegationToken(DescribeDelegationTokenOptions).
DescribeDelegationTokenResult	The result of the KafkaAdminClient.describeDelegationToken(DescribeDelegationTokenOptions) call.
DescribeFeaturesOptions	Options for Admin.describeFeatures(DescribeFeaturesOptions).
DescribeFeaturesResult	The result of the Admin.describeFeatures(DescribeFeaturesOptions) call.
DescribeLogDirsOptions	Options for Admin.describeLogDirs(Collection) The API of this class is evolving, see Admin for details.
DescribeLogDirsResult	The result of the Admin.describeLogDirs(Collection) call.
DescribeMetadataQuorumOptions	Options for Admin.describeMetadataQuorum(DescribeMetadataQuorumOptions)
DescribeMetadataQuorumResult	The result of Admin.describeMetadataQuorum(DescribeMetadataQuorumOptions)
DescribeProducersOptions	Options for Admin.describeProducers(Collection).
DescribeProducersResult
DescribeProducersResult.PartitionProducerState
DescribeReplicaLogDirsOptions	Options for Admin.describeReplicaLogDirs(Collection).
DescribeReplicaLogDirsResult	The result of Admin.describeReplicaLogDirs(Collection).
DescribeReplicaLogDirsResult.ReplicaLogDirInfo
DescribeTopicsOptions	Options for Admin.describeTopics(Collection).
DescribeTopicsResult	The result of the Admin.describeTopics(Collection) call.
DescribeTransactionsOptions	Options for Admin.describeTransactions(Collection).
DescribeTransactionsResult
DescribeUserScramCredentialsOptions	Options for Admin.describeUserScramCredentials(List, DescribeUserScramCredentialsOptions) The API of this class is evolving.
DescribeUserScramCredentialsResult	The result of the Admin.describeUserScramCredentials() call.
ElectLeadersOptions	Options for Admin.electLeaders(ElectionType, Set, ElectLeadersOptions).
ElectLeadersResult	The result of Admin.electLeaders(ElectionType, Set, ElectLeadersOptions) The API of this class is evolving, see Admin for details.
ExpireDelegationTokenOptions	Options for Admin.expireDelegationToken(byte[], ExpireDelegationTokenOptions).
ExpireDelegationTokenResult	The result of the KafkaAdminClient.expireDelegationToken(byte[], ExpireDelegationTokenOptions) call.
FeatureMetadata	Encapsulates details about finalized as well as supported features.
FeatureUpdate	Encapsulates details about an update to a finalized feature.
FenceProducersOptions	Options for Admin.fenceProducers(Collection, FenceProducersOptions) The API of this class is evolving.
FenceProducersResult	The result of the Admin.fenceProducers(Collection) call.
FinalizedVersionRange	Represents a range of version levels supported by every broker in a cluster for some feature.
ForwardingAdmin	ForwardingAdmin is the default value of forwarding.admin.class in MirrorMaker.
KafkaAdminClient	The default implementation of Admin.
ListConsumerGroupOffsetsOptions	Options for Admin.listConsumerGroupOffsets(java.util.Map) and Admin.listConsumerGroupOffsets(String).
ListConsumerGroupOffsetsResult	The result of the Admin.listConsumerGroupOffsets(Map) and Admin.listConsumerGroupOffsets(String) call.
ListConsumerGroupOffsetsSpec	Specification of consumer group offsets to list using Admin.listConsumerGroupOffsets(java.util.Map).
ListConsumerGroupsOptions	Options for Admin.listConsumerGroups().
ListConsumerGroupsResult	The result of the Admin.listConsumerGroups() call.
ListOffsetsOptions	Options for Admin.listOffsets(Map).
ListOffsetsResult	The result of the Admin.listOffsets(Map) call.
ListOffsetsResult.ListOffsetsResultInfo
ListPartitionReassignmentsOptions	Options for Admin.listPartitionReassignments(ListPartitionReassignmentsOptions) The API of this class is evolving.
ListPartitionReassignmentsResult	The result of Admin.listPartitionReassignments(ListPartitionReassignmentsOptions).
ListTopicsOptions	Options for Admin.listTopics().
ListTopicsResult	The result of the Admin.listTopics() call.
ListTransactionsOptions	Options for Admin.listTransactions().
ListTransactionsResult	The result of the Admin.listTransactions() call.
LogDirDescription	A description of a log directory on a particular broker.
MemberAssignment	A description of the assignments of a specific group member.
MemberDescription	A detailed description of a single group instance in the cluster.
MemberToRemove	A struct containing information about the member to be removed.
NewPartitionReassignment	A new partition reassignment, which can be applied via Admin.alterPartitionReassignments(Map, AlterPartitionReassignmentsOptions).
NewPartitions	Describes new partitions for a particular topic in a call to Admin.createPartitions(Map).
NewTopic	A new topic to be created via Admin.createTopics(Collection).
OffsetSpec	This class allows to specify the desired offsets when using KafkaAdminClient.listOffsets(Map, ListOffsetsOptions)
OffsetSpec.EarliestSpec
OffsetSpec.LatestSpec
OffsetSpec.MaxTimestampSpec
OffsetSpec.TimestampSpec
PartitionReassignment	A partition reassignment, which has been listed via Admin.listPartitionReassignments().
ProducerState
QuorumInfo	This class is used to describe the state of the quorum received in DescribeQuorumResponse.
QuorumInfo.ReplicaState
RecordsToDelete	Describe records to delete in a call to Admin.deleteRecords(Map) The API of this class is evolving, see Admin for details.
RemoveMembersFromConsumerGroupOptions	Options for Admin.removeMembersFromConsumerGroup(String, RemoveMembersFromConsumerGroupOptions).
RemoveMembersFromConsumerGroupResult	The result of the Admin.removeMembersFromConsumerGroup(String, RemoveMembersFromConsumerGroupOptions) call.
RenewDelegationTokenOptions	Options for Admin.renewDelegationToken(byte[], RenewDelegationTokenOptions).
RenewDelegationTokenResult	The result of the KafkaAdminClient.expireDelegationToken(byte[], ExpireDelegationTokenOptions) call.
ReplicaInfo	A description of a replica on a particular broker.
ScramCredentialInfo	Mechanism and iterations for a SASL/SCRAM credential associated with a user.
SupportedVersionRange	Represents a range of versions that a particular broker supports for some feature.
TopicDescription	A detailed description of a single topic in the cluster.
TopicListing	A listing of a topic in the cluster.
TransactionDescription
TransactionListing
UnregisterBrokerOptions	Options for Admin.unregisterBroker(int, UnregisterBrokerOptions).
UnregisterBrokerResult	The result of the Admin.unregisterBroker(int, UnregisterBrokerOptions) call.
UpdateFeaturesOptions	Options for Admin.updateFeatures(Map, UpdateFeaturesOptions).
UpdateFeaturesResult	The result of the Admin.updateFeatures(Map, UpdateFeaturesOptions) call.
UserScramCredentialAlteration	A request to alter a user's SASL/SCRAM credentials.
UserScramCredentialDeletion	A request to delete a SASL/SCRAM credential for a user.
UserScramCredentialsDescription	Representation of all SASL/SCRAM credentials associated with a user that can be retrieved, or an exception indicating why credentials could not be retrieved.
UserScramCredentialUpsertion	A request to update/insert a SASL/SCRAM credential for a user.

Enum Summary

Enum	Description
AlterConfigOp.OpType
ConfigEntry.ConfigSource	Source of configuration entries.
ConfigEntry.ConfigType	Data type of configuration entry.
FeatureUpdate.UpgradeType
ScramMechanism	Representation of a SASL/SCRAM Mechanism.
TransactionState