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
invalid reference
ConfluentAdmin#alterBrokerHealth(AlterBrokerHealthSpec, AlterBrokerHealthOptions)
The result of theAdmin.alterClientQuotas(Collection, AlterClientQuotasOptions)
call.A class representing an alter configuration entry containing name, value and operation type.Options forAdmin.incrementalAlterConfigs(Map)
.The result of theAdmin.incrementalAlterConfigs(Map, AlterConfigsOptions)
call.Options for theAdmin.alterConsumerGroupOffsets(String, Map, AlterConsumerGroupOffsetsOptions)
call.The result of theAdmin.alterConsumerGroupOffsets(String, Map)
call.A class representing an alter mirror operation.The result ofConfluentAdmin.alterMirrors(Map, AlterMirrorsOptions)
.The result ofAdmin.alterReplicaLogDirs(Map, AlterReplicaLogDirsOptions)
.The result of theAdmin.alterUserScramCredentials(List)
call.The error that caused a balancer operation (broker removal, broker addition) to end up in the status it is in.A high-level status of any given Confluent Balancer operation.The status of how Confluent Balancer component self-heals.The status of the Confluent Balancer component.A description of the balancer status which is fetched viaConfluentAdmin.describeBalancerStatus(DescribeBalancerStatusOptions)
.A description of a broker addition operation, which has been listed viaConfluentAdmin.describeBrokerAdditions(DescribeBrokerAdditionsOptions)
.A description of a broker removal, which has been listed viaConfluentAdmin.describeBrokerRemovals(DescribeBrokerRemovalsOptions)
.The error that caused a broker removal operation to fail.Denotes the status of the broker replica exclusion sub task of a given Confluent Balancer operation.Denotes the status of the broker shutdown sub task of a given Confluent Balancer operation.A detailed description of a single classic group in the cluster.A description of a cluster that's linked.A listing of a cluster that's linked.A description of a cluster link's switchover info.A description of a cluster link task.The state of a cluster link task.A cluster link task error code and error message.The reason for why a link task is in some sort of error state.A description a topic's switchover info.Options for the even cluster load plan computation.The result ofinvalid reference
ConfluentAdmin#computeEvenClusterLoadPlan(ComputeEvenClusterLoadPlanOptions)
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.This interface contains admin client methods that: are only present in Confluent Server, or existing Admin methods that return or take extra information only available in Confluent Server.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 recordsOptions 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 options to use when fetching the balancer status.The result ofinvalid reference
ConfluentAdmin#describeBrokerHealth(DescribeBrokerHealthOptions)
A description of a broker replica exclusion for the given brokerbrokerId
with the associatedreason
for the exclusion.The result of theAdmin.describeClassicGroups(Collection, DescribeClassicGroupsOptions)
} 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.The options to use when fetching the even cluster load status.Options forAdmin.describeFeatures(DescribeFeaturesOptions)
.The result of theAdmin.describeFeatures(DescribeFeaturesOptions)
call.Options forAdmin.describeLogDirs(Collection)
The result of theAdmin.describeLogDirs(Collection)
call.Options forAdmin.describeProducers(Collection)
.Options forAdmin.describeReplicaLogDirs(Collection)
.The result ofAdmin.describeReplicaLogDirs(Collection)
.The result of theKafkaAdminClient.describeShareGroups(Collection, DescribeShareGroupsOptions)
} call.The result ofConfluentAdmin.describeSwitchoverStatus(linkName)
.Options forAdmin.describeTopics(Collection)
.The result of theAdmin.describeTopics(Collection)
call.Options forAdmin.describeTransactions(Collection)
.The result of theAdmin.describeUserScramCredentials()
call.The result ofAdmin.electLeaders(ElectionType, Set, ElectLeadersOptions)
The API of this class is evolving, seeAdmin
for details.Identifies the endpoint type, as specified by KIP-919.Represents an SBC-computed reassignments plan to be done for the even cluster load task.Broker-related statistics class used in the construction ofEvenClusterLoadPlan
.Holds broker-specific information like broker ID, host, cpu usage percentage, multiple network disk usage in MB, disk usage percentage, measurements in KB/s, total leader replicas, and total replicas.Cluster-related statistics class used in the construction ofEvenClusterLoadPlan
.Cluster balance statistics class used in the construction ofEvenClusterLoadPlan
.Goals-related statistics class used in the construction ofEvenClusterLoadPlan
.Holds SBC goal-specific information about the current average, maximum, and minimum resource cluster utilization statistics.An overview of an SBC goal after going through an even cluster load plan computation.Holds SBC goal-specific information.Holds resource utilization statistics for both the whole cluster like information about CPU, inbound and outbound network traffic, disk usage, etc.Replica movement statistics class used in the construction ofEvenClusterLoadPlan
.The high level status of the even cluster load operation.A description of an even cluster load operation, which has been listed viaConfluentAdmin.describeEvenClusterLoadStatus()
The status containsEvenClusterLoadStatusDescription.healUnevenLoadTrigger
that helps identify if SBC self-healing is enabled for the cluster.A class representing an alter broker exclusion entry containing operation type and reason for exclusion.The error that caused an exclusion operation to fail.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.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.A listing of a group in the cluster.The default implementation ofAdmin
.Options forAdmin.listClientMetricsResources()
.The result of theAdmin.listClientMetricsResources()
call.The result ofConfluentAdmin.listClusterLinks(ListClusterLinksOptions)
.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.listGroups()
.The result of theAdmin.listGroups()
call.Options forConfluentAdmin.listMirrors(ListMirrorsOptions)
.The result ofConfluentAdmin.listMirrors(ListMirrorsOptions)
.Options forAdmin.listOffsets(Map)
.The result of theAdmin.listOffsets(Map)
call.The result of theAdmin.listShareGroupOffsets(Map, ListShareGroupOffsetsOptions)
call.Specification of share group offsets to list usingAdmin.listShareGroupOffsets(Map, ListShareGroupOffsetsOptions)
.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 member in the cluster.A struct containing information about the member to be removed.A description of a topic's mirroring state.The state of the topic mirroring.A new cluster link to be created viaConfluentAdmin.createClusterLinks(Collection, CreateClusterLinksOptions)
.Supplemental new topic data for creating a topic that is a mirror of another.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()
.Denotes the status of the partition reassignments of a given Confluent Balancer operation.This class is used to describe the state of the quorum received in DescribeQuorumResponse.An endpoint for a raft quorum voter.Describe records to delete in a call toAdmin.deleteRecords(Map)
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.The result ofConfluentAdmin.replicaStatus(Set, ReplicaStatusOptions)
.Mechanism and iterations for a SASL/SCRAM credential associated with a user.Representation of a SASL/SCRAM Mechanism.A detailed description of a single share group in the cluster.A description of the assignments of a specific share group member.A detailed description of a single share group member in the cluster.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.The options to use when triggering an even cluster load operation withinvalid reference
ConfluentAdmin#triggerEvenClusterLoad(TriggerEvenClusterLoadOptions)
The result ofinvalid reference
ConfluentAdmin#triggerEvenClusterLoad(TriggerEvenClusterLoadOptions)
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.