Class KafkaAdminClient

java.lang.Object

org.apache.kafka.clients.admin.AdminClient

org.apache.kafka.clients.admin.KafkaAdminClient

All Implemented Interfaces:

io.confluent.kafka.clients.CloudAdmin, AutoCloseable, Admin, ConfluentAdmin

public class KafkaAdminClient
extends AdminClient
implements io.confluent.kafka.clients.CloudAdmin

The default implementation of Admin. An instance of this class is created by invoking one of the create() methods in AdminClient. Users should not refer to this class directly.

This class is thread-safe.

Method Summary

Modifier and Type	Method	Description
AbortTransactionResult	abortTransaction(AbortTransactionSpec spec, AbortTransactionOptions options)	Forcefully abort a transaction which is open on a topic partition.
AddRaftVoterResult	addRaftVoter(int voterId, Uuid voterDirectoryId, Set<RaftVoterEndpoint> endpoints, AddRaftVoterOptions options)	Add a new voter node to the KRaft metadata quorum.
AlterBrokerHealthResult	alterBrokerHealth(AlterBrokerHealthSpec data, AlterBrokerHealthOptions options)
AlterBrokerReplicaExclusionsResult	alterBrokerReplicaExclusions(Map<Integer, ExclusionOp> operations, AlterBrokerReplicaExclusionsOptions options)	Alters the broker replica exclusions in the cluster.
io.confluent.kafka.clients.AlterCellResult	alterCell(int cellId, CellState state, io.confluent.kafka.clients.AlterCellOptions options)
io.confluent.kafka.clients.AlterCellMigrationResult	alterCellMigration(CellMigrationState state, io.confluent.kafka.clients.AlterCellMigrationOptions options)
AlterClientQuotasResult	alterClientQuotas(Collection<ClientQuotaAlteration> entries, AlterClientQuotasOptions options)	Alters client quota configurations with the specified alterations.
AlterConsumerGroupOffsetsResult	alterConsumerGroupOffsets(String groupId, Map<TopicPartition, OffsetAndMetadata> offsets, AlterConsumerGroupOffsetsOptions options)	Alters offsets for the specified group.
AlterMirrorsResult	alterMirrors(Map<String, AlterMirrorOp> ops, AlterMirrorsOptions options)	Performs a state alteration for topic mirroring.
AlterPartitionReassignmentsResult	alterPartitionReassignments(Map<TopicPartition, Optional<NewPartitionReassignment>> reassignments, AlterPartitionReassignmentsOptions options)	Change the reassignments for one or more partitions.
AlterReplicaLogDirsResult	alterReplicaLogDirs(Map<TopicPartitionReplica, String> replicaAssignment, AlterReplicaLogDirsOptions options)	Change the log directory for the specified replicas.
AlterShareGroupOffsetsResult	alterShareGroupOffsets(String groupId, Map<TopicPartition, Long> offsets, AlterShareGroupOffsetsOptions options)	Alters offsets for the specified group.
AlterStreamsGroupOffsetsResult	alterStreamsGroupOffsets(String groupId, Map<TopicPartition, OffsetAndMetadata> offsets, AlterStreamsGroupOffsetsOptions options)	Alters offsets for the specified group.
AlterUserScramCredentialsResult	alterUserScramCredentials(List<UserScramCredentialAlteration> alterations, AlterUserScramCredentialsOptions options)	Alter SASL/SCRAM credentials.
io.confluent.kafka.clients.AssignBrokersToCellResult	assignBrokersToCell(Collection<Integer> brokers, int cellId, boolean force, io.confluent.kafka.clients.AssignBrokersToCellOptions options)
io.confluent.kafka.clients.AssignTenantsToCellResult	assignTenantsToCells(Collection<org.apache.kafka.common.message.AssignTenantsToCellRequestData.TenantToCellAssignment> assignments, io.confluent.kafka.clients.AssignTenantsToCellOptions options)
Uuid	clientInstanceId(Duration timeout)	Determines the client's unique client instance ID used for telemetry.
void	close(Duration timeout)	Close the Admin client and release all associated resources.
ComputeEvenClusterLoadPlanResult	computeEvenClusterLoadPlan(List<String> goalList, ComputeEvenClusterLoadPlanOptions options)	Compute and return an even cluster load plan for the cluster based on the rebalance goals.
CreateAclsResult	createAcls(Collection<AclBinding> acls, CreateAclsOptions options)	Creates access control lists (ACLs) which are bound to specific resources.
io.confluent.kafka.clients.CreateCellResult	createCell(int cellId, CellState state, io.confluent.kafka.clients.CreateCellOptions options)
CreateAclsResult	createCentralizedAcls(Collection<AclBinding> acls, CreateAclsOptions options, String clusterId, int writerBrokerId)	Creates access control lists (ACLs) which are bound to specific resources.
CreateClusterLinksResult	createClusterLinks(Collection<NewClusterLink> clusterLinks, CreateClusterLinksOptions options)	Creates links to remote clusters with the specified configurations for performing inter-cluster communications.
CreateDelegationTokenResult	createDelegationToken(CreateDelegationTokenOptions options)	Create a Delegation Token.
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.
CreateTopicsResult	createTopics(Collection<NewTopic> newTopics, CreateTopicsOptions options)	Create a batch of new topics.
DeleteAclsResult	deleteAcls(Collection<AclBindingFilter> filters, DeleteAclsOptions options)	Deletes access control lists (ACLs) according to the supplied filters.
io.confluent.kafka.clients.DeleteCellResult	deleteCell(int cellId, io.confluent.kafka.clients.DeleteCellOptions options)
DeleteAclsResult	deleteCentralizedAcls(Collection<AclBindingFilter> filters, DeleteAclsOptions options, String clusterId, int writerBrokerId)	Deletes access control lists (ACLs) according to the supplied filters.
DeleteClusterLinksResult	deleteClusterLinks(Collection<String> linkNames, DeleteClusterLinksOptions options)	Deletes established links to remote clusters with the provided link names.
DeleteConsumerGroupOffsetsResult	deleteConsumerGroupOffsets(String groupId, Set<TopicPartition> partitions, DeleteConsumerGroupOffsetsOptions options)	Delete committed offsets for a set of partitions in a consumer group.
DeleteConsumerGroupsResult	deleteConsumerGroups(Collection<String> groupIds, DeleteConsumerGroupsOptions options)	Delete consumer groups from the cluster.
DeleteRecordsResult	deleteRecords(Map<TopicPartition, RecordsToDelete> recordsToDelete, DeleteRecordsOptions options)	Delete records whose offset is smaller than the given offset of the corresponding partition.
DeleteShareGroupOffsetsResult	deleteShareGroupOffsets(String groupId, Set<String> topics, DeleteShareGroupOffsetsOptions options)	Delete offsets for a set of topics in a share group.
DeleteShareGroupsResult	deleteShareGroups(Collection<String> groupIds, DeleteShareGroupsOptions options)	Delete share groups from the cluster.
DeleteStreamsGroupOffsetsResult	deleteStreamsGroupOffsets(String groupId, Set<TopicPartition> partitions, DeleteStreamsGroupOffsetsOptions options)	Delete committed offsets for a set of partitions in a streams group.
DeleteStreamsGroupsResult	deleteStreamsGroups(Collection<String> groupIds, DeleteStreamsGroupsOptions options)	Delete streams groups from the cluster.
io.confluent.kafka.clients.DeleteTenantsResult	deleteTenants(Collection<String> tenantIds, io.confluent.kafka.clients.DeleteTenantsOptions options)
DeleteTopicsResult	deleteTopics(TopicCollection topics, DeleteTopicsOptions options)	Delete a batch of topics.
DescribeAclsResult	describeAcls(AclBindingFilter filter, DescribeAclsOptions options)	Lists access control lists (ACLs) according to the supplied filter.
DescribeBalancerStatusResult	describeBalancerStatus(DescribeBalancerStatusOptions options)	Describes status of confluent balancer component.
DescribeBrokerAdditionsResult	describeBrokerAdditions(DescribeBrokerAdditionsOptions options)	Describes all the broker additions in the cluster.
DescribeBrokerHealthResult	describeBrokerHealth(DescribeBrokerHealthOptions options)
DescribeBrokerRemovalsResult	describeBrokerRemovals(DescribeBrokerRemovalsOptions options)	Describes all the broker removals in the cluster.
DescribeBrokerReplicaExclusionsResult	describeBrokerReplicaExclusions(DescribeBrokerReplicaExclusionsOptions options)	Describes the active broker replica exclusions in the cluster.
io.confluent.kafka.clients.CellLoadResult	describeCellLoad(Collection<Integer> cellIds)
io.confluent.kafka.clients.CellLoadResult	describeCellLoad(Collection<Integer> cellIds, io.confluent.kafka.clients.DescribeCellLoadOptions options)
io.confluent.kafka.clients.DescribeCellMigrationResult	describeCellMigration(io.confluent.kafka.clients.DescribeCellMigrationOptions options)
io.confluent.kafka.clients.DescribeCellsResult	describeCells(Collection<Integer> cellIds, io.confluent.kafka.clients.DescribeCellsOptions options)
DescribeClassicGroupsResult	describeClassicGroups(Collection<String> groupIds, DescribeClassicGroupsOptions options)	Describe some classic groups in the cluster.
DescribeClientQuotasResult	describeClientQuotas(ClientQuotaFilter filter, DescribeClientQuotasOptions options)	Describes all entities matching the provided filter that have at least one client quota configuration value defined.
DescribeClusterResult	describeCluster(DescribeClusterOptions options)	Get information about the nodes in the cluster.
DescribeClusterLinksResult	describeClusterLinks(DescribeClusterLinksOptions options)	Describe the cluster links.
void	describeClusterLinksToController(DescribeClusterLinksOptions options, org.apache.kafka.common.internals.KafkaFutureImpl<Collection<ClusterLinkDescription>> result, long now)
DescribeConfigsResult	describeConfigs(Collection<ConfigResource> configResources, DescribeConfigsOptions options)	Get the configuration for the specified resources.
DescribeConsumerGroupsResult	describeConsumerGroups(Collection<String> groupIds, DescribeConsumerGroupsOptions options)	Describe some consumer groups in the cluster.
DescribeDelegationTokenResult	describeDelegationToken(DescribeDelegationTokenOptions options)	Describe the Delegation Tokens.
DescribeEvenClusterLoadStatusResult	describeEvenClusterLoadStatus(DescribeEvenClusterLoadStatusOptions options)	Describe the status of the even cluster load operation.
DescribeFeaturesResult	describeFeatures(DescribeFeaturesOptions options)	Describes finalized as well as supported features.
DescribeLogDirsResult	describeLogDirs(Collection<Integer> brokers, DescribeLogDirsOptions options)	Query the information of all log directories on the given set of brokers
DescribeMetadataQuorumResult	describeMetadataQuorum(DescribeMetadataQuorumOptions options)	Describes the state of the metadata quorum.
DescribeMirrorsResult	describeMirrors(Collection<String> topics, DescribeMirrorsOptions options)	Describes the state of mirrored topics, i.e.
DescribeMirrorsResult	describeMirrorsToController(DescribeMirrorsOptions options, Map<String, org.apache.kafka.common.internals.KafkaFutureImpl<MirrorTopicDescription>> result, Long now)
io.confluent.kafka.clients.DescribeNetworkResult	describeNetwork(String tenant, String listenerName, Collection<String> ipAddresses, Collection<String> clientApiKeyList, Collection<Integer> brokerIds, io.confluent.kafka.clients.DescribeNetworkOptions options)
DescribeProducersResult	describeProducers(Collection<TopicPartition> topicPartitions, DescribeProducersOptions options)	Describe active producer state on a set of topic partitions.
DescribeReplicaLogDirsResult	describeReplicaLogDirs(Collection<TopicPartitionReplica> replicas, DescribeReplicaLogDirsOptions options)	Query the replica log directory information for the specified replicas.
DescribeShareGroupsResult	describeShareGroups(Collection<String> groupIds, DescribeShareGroupsOptions options)	Describe some share groups in the cluster.
DescribeStreamsGroupsResult	describeStreamsGroups(Collection<String> groupIds, DescribeStreamsGroupsOptions options)	Describe streams groups in the cluster.
DescribeSwitchoverStatusResult	describeSwitchoverStatus(String linkName)	Describe the cluster link switchover status.
io.confluent.kafka.clients.DescribeTenantsResult	describeTenants(Collection<String> tenantIds, io.confluent.kafka.clients.DescribeTenantsOptions options)
DescribeTopicsResult	describeTopics(TopicCollection topics, DescribeTopicsOptions options)	Describe some topics in the cluster.
DescribeTransactionsResult	describeTransactions(Collection<String> transactionalIds, DescribeTransactionsOptions options)	Describe the state of a set of transactional IDs from the respective transaction coordinators, which are dynamically discovered.
DescribeUserScramCredentialsResult	describeUserScramCredentials(List<String> users, DescribeUserScramCredentialsOptions options)	Describe SASL/SCRAM credentials.
ElectLeadersResult	electLeaders(ElectionType electionType, Set<TopicPartition> topicPartitions, ElectLeadersOptions options)	Elect a replica as leader for the given partitions, or for all partitions if the argument to partitions is null.
ExpireDelegationTokenResult	expireDelegationToken(byte[] hmac, ExpireDelegationTokenOptions options)	Expire a Delegation Token.
FenceProducersResult	fenceProducers(Collection<String> transactionalIds, FenceProducersOptions options)	Fence out all active producers that use any of the provided transactional IDs.
TerminateTransactionResult	forceTerminateTransaction(String transactionalId, TerminateTransactionOptions options)	Forcefully terminates an ongoing transaction for a given transactional ID.
AlterConfigsResult	incrementalAlterConfigs(Map<ConfigResource, Collection<AlterConfigOp>> configs, AlterConfigsOptions options)	Incrementally update the configuration for the specified resources.
ListClientMetricsResourcesResult	listClientMetricsResources(ListClientMetricsResourcesOptions options)	List the client metrics configuration resources available in the cluster.
ListClusterLinksResult	listClusterLinks(ListClusterLinksOptions options)	Lists the cluster links.
ListConfigResourcesResult	listConfigResources(Set<ConfigResource.Type> configResourceTypes, ListConfigResourcesOptions options)	List the configuration resources available in the cluster which matches config resource type.
ListConsumerGroupOffsetsResult	listConsumerGroupOffsets(Map<String, ListConsumerGroupOffsetsSpec> groupSpecs, ListConsumerGroupOffsetsOptions options)	List the consumer group offsets available in the cluster for the specified consumer groups.
ListConsumerGroupsResult	listConsumerGroups(ListConsumerGroupsOptions options)	Deprecated, for removal: This API element is subject to removal in a future version.
ListGroupsResult	listGroups(ListGroupsOptions options)	List the groups available in the cluster.
ListMirrorsResult	listMirrors(ListMirrorsOptions options)	Lists the mirrored topics, i.e.
ListOffsetsResult	listOffsets(Map<TopicPartition, OffsetSpec> topicPartitionOffsets, ListOffsetsOptions options)	List offset for the specified partitions.
ListPartitionReassignmentsResult	listPartitionReassignments(Optional<Set<TopicPartition>> partitions, ListPartitionReassignmentsOptions options)
ListShareGroupOffsetsResult	listShareGroupOffsets(Map<String, ListShareGroupOffsetsSpec> groupSpecs, ListShareGroupOffsetsOptions options)	List the share group offsets available in the cluster for the specified share groups.
ListStreamsGroupOffsetsResult	listStreamsGroupOffsets(Map<String, ListStreamsGroupOffsetsSpec> groupSpecs, ListStreamsGroupOffsetsOptions options)	List the streams group offsets available in the cluster for the specified streams groups.
ListTopicsResult	listTopics(ListTopicsOptions options)	List the topics available in the cluster.
ListTransactionsResult	listTransactions(ListTransactionsOptions options)	List active transactions in the cluster.
Map<MetricName, ? extends Metric>	metrics()	Get the metrics kept by the adminClient
void	registerMetricForSubscription(KafkaMetric metric)	Add the provided application metric for subscription.
RemoveBrokersResult	removeBrokers(List<Integer> brokersToRemove, RemoveBrokersOptions options)	Drain data off a given set of brokers and remove them from the cluster via shutdown.
RemoveMembersFromConsumerGroupResult	removeMembersFromConsumerGroup(String groupId, RemoveMembersFromConsumerGroupOptions options)	Remove members from the consumer group by given member identities.
RemoveRaftVoterResult	removeRaftVoter(int voterId, Uuid voterDirectoryId, RemoveRaftVoterOptions options)	Remove a voter node from the KRaft metadata quorum.
RenewDelegationTokenResult	renewDelegationToken(byte[] hmac, RenewDelegationTokenOptions options)	Renew a Delegation Token.
ReplicaStatusResult	replicaStatus(Set<TopicPartition> partitions, ReplicaStatusOptions options)	Retrieves the status of the replicas for a set of partitions, including observers.
ReportClusterLinkStatusResult	reportClusterLinkStatus(Integer publisherBrokerId, Collection<org.apache.kafka.common.requests.ReportClusterLinkStatusRequest.ClusterLinkMirrorState> linkMirrorStates, ReportClusterLinkStatusOptions options)	Internal method to report Cluster Link Status.
ResolveOffsetRangeResult	resolveOffsetRange(Map<TopicIdAndPartition, ResolveOffsetRangeSpec> topicPartitionOffsetRanges, ResolveOffsetRangeOptions options)
TriggerEvenClusterLoadResult	triggerEvenClusterLoad(List<String> goalList, TriggerEvenClusterLoadOptions options)	Triggers the even cluster load operation.
io.confluent.kafka.clients.UnassignBrokersFromCellResult	unassignBrokersFromCell(Collection<Integer> brokers, boolean force, io.confluent.kafka.clients.UnassignBrokersFromCellOptions options)
UnregisterBrokerResult	unregisterBroker(int brokerId, UnregisterBrokerOptions options)	Unregister a broker.
void	unregisterMetricFromSubscription(KafkaMetric metric)	Remove the provided application metric for subscription.
UpdateFeaturesResult	updateFeatures(Map<String, FeatureUpdate> featureUpdates, UpdateFeaturesOptions options)	Applies specified updates to finalized features.

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

create, create

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.clients.admin.Admin

abortTransaction, addRaftVoter, alterClientQuotas, alterConsumerGroupOffsets, alterPartitionReassignments, alterReplicaLogDirs, alterShareGroupOffsets, alterStreamsGroupOffsets, alterUserScramCredentials, close, createAcls, createDelegationToken, createPartitions, createTopics, deleteAcls, deleteConsumerGroupOffsets, deleteConsumerGroups, deleteRecords, deleteShareGroupOffsets, deleteShareGroups, deleteStreamsGroupOffsets, deleteStreamsGroups, deleteTopics, deleteTopics, deleteTopics, describeAcls, describeClassicGroups, describeClientQuotas, describeCluster, describeConfigs, describeConsumerGroups, describeDelegationToken, describeFeatures, describeLogDirs, describeMetadataQuorum, describeProducers, describeReplicaLogDirs, describeShareGroups, describeStreamsGroups, describeTopics, describeTopics, describeTopics, describeTransactions, describeUserScramCredentials, describeUserScramCredentials, electLeaders, expireDelegationToken, fenceProducers, forceTerminateTransaction, incrementalAlterConfigs, listClientMetricsResources, listConfigResources, listConsumerGroupOffsets, listConsumerGroupOffsets, listConsumerGroupOffsets, listConsumerGroups, listGroups, listOffsets, listPartitionReassignments, listPartitionReassignments, listPartitionReassignments, listPartitionReassignments, listShareGroupOffsets, listStreamsGroupOffsets, listTopics, listTransactions, removeRaftVoter, renewDelegationToken, unregisterBroker

Methods inherited from interface io.confluent.kafka.clients.CloudAdmin

alterCell, alterCellMigration, assignBrokersToCell, assignTenantsToCells, createCell, deleteCell, deleteTenants, describeCellMigration, describeCells, describeTenants, unassignBrokersFromCell

Methods inherited from interface org.apache.kafka.clients.admin.ConfluentAdmin

alterBrokerReplicaExclusions, computeEvenClusterLoadPlan, computeEvenClusterLoadPlan, describeBalancerStatus, describeBrokerAdditions, describeBrokerRemovals, describeBrokerReplicaExclusions, describeEvenClusterLoadStatus, removeBrokers, triggerEvenClusterLoad, triggerEvenClusterLoad

Method Details

close

public void close(Duration timeout)

Description copied from interface: Admin

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.

Specified by:

close in interface Admin

Parameters:

timeout - The time to use for the wait time.

createTopics

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

Description copied from interface: Admin

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, Admin.listTopics() and Admin.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.

Specified by:

createTopics in interface Admin

Parameters:

newTopics - The new topics to create.

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

Returns:

The CreateTopicsResult.

deleteTopics

public DeleteTopicsResult deleteTopics(TopicCollection topics,
 DeleteTopicsOptions options)

Description copied from interface: Admin

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(Collection) may continue to return information about the deleted topics.

If delete.topic.enable is set to false on the brokers, an exception will be returned to the client indicating that topic deletion is disabled.

When using topic IDs, this operation is supported by brokers with inter-broker protocol 2.8 or higher. When using topic names, this operation is supported by brokers with version 0.10.1.0 or higher.

Specified by:

deleteTopics in interface Admin

Parameters:

topics - The topics to delete.

options - The options to use when deleting the topics.

Returns:

The DeleteTopicsResult.

listTopics

public ListTopicsResult listTopics(ListTopicsOptions options)

Description copied from interface: Admin

List the topics available in the cluster.

Specified by:

listTopics in interface Admin

Parameters:

options - The options to use when listing the topics.

Returns:

The ListTopicsResult.

describeTopics

public DescribeTopicsResult describeTopics(TopicCollection topics,
 DescribeTopicsOptions options)

Description copied from interface: Admin

Describe some topics in the cluster. When using topic IDs, this operation is supported by brokers with version 3.1.0 or higher.

Specified by:

describeTopics in interface Admin

Parameters:

topics - The topics to describe.

options - The options to use when describing the topics.

Returns:

The DescribeTopicsResult.

describeCluster

public DescribeClusterResult describeCluster(DescribeClusterOptions options)

Description copied from interface: Admin

Get information about the nodes in the cluster.

To obtain broker cluster information, you must configure AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG. To obtain controller cluster information, you must configure AdminClientConfig.BOOTSTRAP_CONTROLLERS_CONFIG.

Specified by:

describeCluster in interface Admin

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 interface: Admin

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 interface Admin

Parameters:

filter - The filter to use.

options - The options to use when listing the ACLs.

Returns:

The DescribeAclsResult.

createAcls

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

Description copied from interface: Admin

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.

Specified by:

createAcls in interface Admin

Parameters:

acls - The ACLs to create

options - The options to use when creating the ACLs.

Returns:

The CreateAclsResult.

createCentralizedAcls

@Confluent
public CreateAclsResult createCentralizedAcls(Collection<AclBinding> acls,
 CreateAclsOptions options,
 String clusterId,
 int writerBrokerId)

Description copied from interface: ConfluentAdmin

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.

Specified by:

createCentralizedAcls in interface ConfluentAdmin

Parameters:

acls - The ACLs to create

options - The options to use when creating the ACLs.

clusterId - Cluster id for which ACLs are being updated

writerBrokerId - Broker id of the current centralized metadata master writer

Returns:

The CreateAclsResult.

deleteAcls

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

Description copied from interface: Admin

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.

Specified by:

deleteAcls in interface Admin

Parameters:

filters - The filters to use.

options - The options to use when deleting the ACLs.

Returns:

The DeleteAclsResult.

deleteCentralizedAcls

@Confluent
public DeleteAclsResult deleteCentralizedAcls(Collection<AclBindingFilter> filters,
 DeleteAclsOptions options,
 String clusterId,
 int writerBrokerId)

Description copied from interface: ConfluentAdmin

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.

Specified by:

deleteCentralizedAcls in interface ConfluentAdmin

Parameters:

filters - The filters to use.

options - The options to use when deleting the ACLs.

clusterId - Cluster id for which ACLs are being updated

writerBrokerId - Broker id of the current centralized metadata master writer

Returns:

The DeleteAclsResult.

resolveOffsetRange

@Confluent
public ResolveOffsetRangeResult resolveOffsetRange(Map<TopicIdAndPartition, ResolveOffsetRangeSpec> topicPartitionOffsetRanges,
 ResolveOffsetRangeOptions options)

Specified by:

resolveOffsetRange in interface ConfluentAdmin

describeConfigs

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

Description copied from interface: Admin

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.

The different behavior of nonexistent resource:

• ConfigResource.Type.BROKER: will throw a TimeoutException exception
• ConfigResource.Type.TOPIC: will throw a UnknownTopicOrPartitionException exception
• ConfigResource.Type.GROUP: just return default configs even if the target group is nonexistent
• ConfigResource.Type.BROKER_LOGGER: will throw a TimeoutException exception
• ConfigResource.Type.CLIENT_METRICS: will return empty configs

Note that you cannot describe broker configs or broker logger using AdminClientConfig.BOOTSTRAP_CONTROLLERS_CONFIG, and you cannot describe controller configs or controller logger using AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG.

This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

describeConfigs in interface Admin

Parameters:

configResources - See relevant type ConfigResource.Type

options - The options to use when describing configs

Returns:

The DescribeConfigsResult

incrementalAlterConfigs

public AlterConfigsResult incrementalAlterConfigs(Map<ConfigResource, Collection<AlterConfigOp>> configs,
 AlterConfigsOptions options)

Description copied from interface: Admin

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 AlterConfigsResult:

• 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.
• UnknownTopicOrPartitionException if the Topic doesn't exist.
• 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.

Specified by:

incrementalAlterConfigs in interface Admin

Parameters:

configs - The resources with their configs

options - The options to use when altering configs

Returns:

The AlterConfigsResult

alterReplicaLogDirs

public AlterReplicaLogDirsResult alterReplicaLogDirs(Map<TopicPartitionReplica, String> replicaAssignment,
 AlterReplicaLogDirsOptions options)

Description copied from interface: Admin

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. For detailed result, inspect the returned AlterReplicaLogDirsResult instance.

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.

Specified by:

alterReplicaLogDirs in interface Admin

Parameters:

replicaAssignment - The replicas with their log directory absolute path

options - The options to use when changing replica dir

Returns:

The AlterReplicaLogDirsResult

describeLogDirs

public DescribeLogDirsResult describeLogDirs(Collection<Integer> brokers,
 DescribeLogDirsOptions options)

Description copied from interface: Admin

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.

Specified by:

describeLogDirs in interface Admin

Parameters:

brokers - A list of brokers

options - The options to use when querying log dir info

Returns:

The DescribeLogDirsResult

describeReplicaLogDirs

public DescribeReplicaLogDirsResult describeReplicaLogDirs(Collection<TopicPartitionReplica> replicas,
 DescribeReplicaLogDirsOptions options)

Description copied from interface: Admin

Query the replica log directory information for the specified replicas.

This operation is supported by brokers with version 1.0.0 or higher.

Specified by:

describeReplicaLogDirs in interface Admin

Parameters:

replicas - The replicas to query

options - The options to use when querying replica log dir info

Returns:

The DescribeReplicaLogDirsResult

createPartitions

public CreatePartitionsResult createPartitions(Map<String, NewPartitions> newPartitions,
 CreatePartitionsOptions options)

Description copied from interface: Admin

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, Admin.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.

Specified by:

createPartitions in interface Admin

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 partitions.

Returns:

The CreatePartitionsResult.

deleteRecords

public DeleteRecordsResult deleteRecords(Map<TopicPartition, RecordsToDelete> recordsToDelete,
 DeleteRecordsOptions options)

Description copied from interface: Admin

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.

Specified by:

deleteRecords in interface Admin

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

public CreateDelegationTokenResult createDelegationToken(CreateDelegationTokenOptions options)

Description copied from interface: Admin

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().

Specified by:

createDelegationToken in interface Admin

Parameters:

options - The options to use when creating delegation token.

Returns:

The CreateDelegationTokenResult.

renewDelegationToken

public RenewDelegationTokenResult renewDelegationToken(byte[] hmac,
 RenewDelegationTokenOptions options)

Description copied from interface: Admin

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().

Specified by:

renewDelegationToken in interface Admin

Parameters:

hmac - HMAC of the Delegation token

options - The options to use when renewing delegation token.

Returns:

The RenewDelegationTokenResult.

expireDelegationToken

public ExpireDelegationTokenResult expireDelegationToken(byte[] hmac,
 ExpireDelegationTokenOptions options)

Description copied from interface: Admin

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().

Specified by:

expireDelegationToken in interface Admin

Parameters:

hmac - HMAC of the Delegation token

options - The options to use when expiring delegation token.

Returns:

The ExpireDelegationTokenResult.

describeDelegationToken

public DescribeDelegationTokenResult describeDelegationToken(DescribeDelegationTokenOptions options)

Description copied from interface: Admin

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().

Specified by:

describeDelegationToken in interface Admin

Parameters:

options - The options to use when describing delegation tokens.

Returns:

The DescribeDelegationTokenResult.

listGroups

public ListGroupsResult listGroups(ListGroupsOptions options)

Description copied from interface: Admin

List the groups available in the cluster.

Specified by:

listGroups in interface Admin

Parameters:

options - The options to use when listing the groups.

Returns:

The ListGroupsResult.

describeConsumerGroups

public DescribeConsumerGroupsResult describeConsumerGroups(Collection<String> groupIds,
 DescribeConsumerGroupsOptions options)

Description copied from interface: Admin

Describe some consumer groups in the cluster.

Specified by:

describeConsumerGroups in interface Admin

Parameters:

groupIds - The IDs of the groups to describe.

options - The options to use when describing the groups.

Returns:

The DescribeConsumerGroupsResult.

listConsumerGroups

@Deprecated(since="4.1",
            forRemoval=true)
public ListConsumerGroupsResult listConsumerGroups(ListConsumerGroupsOptions options)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Admin

List the consumer groups available in the cluster.

Specified by:

listConsumerGroups in interface Admin

Parameters:

options - The options to use when listing the consumer groups.

Returns:

The ListConsumerGroupsResult.

listConsumerGroupOffsets

public ListConsumerGroupOffsetsResult listConsumerGroupOffsets(Map<String, ListConsumerGroupOffsetsSpec> groupSpecs,
 ListConsumerGroupOffsetsOptions options)

Description copied from interface: Admin

List the consumer group offsets available in the cluster for the specified consumer groups.

Specified by:

listConsumerGroupOffsets in interface Admin

Parameters:

groupSpecs - Map of consumer group ids to a spec that specifies the topic partitions of the group to list offsets for.

options - The options to use when listing the consumer group offsets.

Returns:

The ListConsumerGroupOffsetsResult

listStreamsGroupOffsets

public ListStreamsGroupOffsetsResult listStreamsGroupOffsets(Map<String, ListStreamsGroupOffsetsSpec> groupSpecs,
 ListStreamsGroupOffsetsOptions options)

Description copied from interface: Admin

List the streams group offsets available in the cluster for the specified streams groups. Note: this method effectively does the same as the corresponding consumer group method Admin.listConsumerGroupOffsets(java.lang.String, org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions) does.

Specified by:

listStreamsGroupOffsets in interface Admin

Parameters:

groupSpecs - Map of streams group ids to a spec that specifies the topic partitions of the group to list offsets for.

options - The options to use when listing the streams group offsets.

Returns:

The ListStreamsGroupOffsetsResult

deleteConsumerGroups

public DeleteConsumerGroupsResult deleteConsumerGroups(Collection<String> groupIds,
 DeleteConsumerGroupsOptions options)

Description copied from interface: Admin

Delete consumer groups from the cluster.

Specified by:

deleteConsumerGroups in interface Admin

Parameters:

options - The options to use when deleting a consumer group.

Returns:

The DeleteConsumerGroupsResult.

deleteStreamsGroups

public DeleteStreamsGroupsResult deleteStreamsGroups(Collection<String> groupIds,
 DeleteStreamsGroupsOptions options)

Description copied from interface: Admin

Delete streams groups from the cluster. Note: this method effectively does the same as the corresponding consumer group method Admin.deleteConsumerGroups(java.util.Collection<java.lang.String>, org.apache.kafka.clients.admin.DeleteConsumerGroupsOptions) does.

Specified by:

deleteStreamsGroups in interface Admin

Parameters:

options - The options to use when deleting a streams group.

Returns:

The DeleteStreamsGroupsResult.

deleteConsumerGroupOffsets

public DeleteConsumerGroupOffsetsResult deleteConsumerGroupOffsets(String groupId,
 Set<TopicPartition> partitions,
 DeleteConsumerGroupOffsetsOptions options)

Description copied from interface: Admin

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.

Specified by:

deleteConsumerGroupOffsets in interface Admin

Parameters:

options - The options to use when deleting offsets in a consumer group.

Returns:

The DeleteConsumerGroupOffsetsResult.

deleteStreamsGroupOffsets

public DeleteStreamsGroupOffsetsResult deleteStreamsGroupOffsets(String groupId,
 Set<TopicPartition> partitions,
 DeleteStreamsGroupOffsetsOptions options)

Description copied from interface: Admin

Delete committed offsets for a set of partitions in a streams group. This will succeed at the partition level only if the group is not actively subscribed to the corresponding topic. Note: this method effectively does the same as the corresponding consumer group method Admin.deleteConsumerGroupOffsets(java.lang.String, java.util.Set<org.apache.kafka.common.TopicPartition>, org.apache.kafka.clients.admin.DeleteConsumerGroupOffsetsOptions) does.

Specified by:

deleteStreamsGroupOffsets in interface Admin

Parameters:

options - The options to use when deleting offsets in a streams group.

Returns:

The DeleteStreamsGroupOffsetsResult.

describeShareGroups

public DescribeShareGroupsResult describeShareGroups(Collection<String> groupIds,
 DescribeShareGroupsOptions options)

Description copied from interface: Admin

Describe some share groups in the cluster.

Specified by:

describeShareGroups in interface Admin

Parameters:

groupIds - The IDs of the groups to describe.

options - The options to use when describing the groups.

Returns:

The DescribeShareGroupsResult.

alterShareGroupOffsets

public AlterShareGroupOffsetsResult alterShareGroupOffsets(String groupId,
 Map<TopicPartition, Long> offsets,
 AlterShareGroupOffsetsOptions options)

Description copied from interface: Admin

Alters offsets for the specified group. In order to succeed, the group must be empty.

This operation is not transactional, so it may succeed for some partitions while fail for others.

Specified by:

alterShareGroupOffsets in interface Admin

Parameters:

groupId - The group for which to alter offsets.

offsets - A map of offsets by partition. Partitions not specified in the map are ignored.

options - The options to use when altering the offsets.

Returns:

The AlterShareGroupOffsetsResult.

listShareGroupOffsets

public ListShareGroupOffsetsResult listShareGroupOffsets(Map<String, ListShareGroupOffsetsSpec> groupSpecs,
 ListShareGroupOffsetsOptions options)

Description copied from interface: Admin

List the share group offsets available in the cluster for the specified share groups.

Specified by:

listShareGroupOffsets in interface Admin

Parameters:

groupSpecs - Map of share group ids to a spec that specifies the topic partitions of the group to list offsets for.

options - The options to use when listing the share group offsets.

Returns:

The ListShareGroupOffsetsResult

deleteShareGroupOffsets

public DeleteShareGroupOffsetsResult deleteShareGroupOffsets(String groupId,
 Set<String> topics,
 DeleteShareGroupOffsetsOptions options)

Description copied from interface: Admin

Delete offsets for a set of topics in a share group.

Specified by:

deleteShareGroupOffsets in interface Admin

Parameters:

groupId - The group for which to delete offsets.

topics - The topics for which to delete offsets.

options - The options to use when deleting offsets in a share group.

Returns:

The DeleteShareGroupOffsetsResult.

describeStreamsGroups

public DescribeStreamsGroupsResult describeStreamsGroups(Collection<String> groupIds,
 DescribeStreamsGroupsOptions options)

Description copied from interface: Admin

Describe streams groups in the cluster.

Specified by:

describeStreamsGroups in interface Admin

Parameters:

groupIds - The IDs of the groups to describe.

options - The options to use when describing the groups.

Returns:

The DescribeStreamsGroupsResult.

describeClassicGroups

public DescribeClassicGroupsResult describeClassicGroups(Collection<String> groupIds,
 DescribeClassicGroupsOptions options)

Description copied from interface: Admin

Describe some classic groups in the cluster.

Specified by:

describeClassicGroups in interface Admin

Parameters:

groupIds - The IDs of the groups to describe.

options - The options to use when describing the groups.

Returns:

The DescribeClassicGroupsResult.

deleteShareGroups

public DeleteShareGroupsResult deleteShareGroups(Collection<String> groupIds,
 DeleteShareGroupsOptions options)

Description copied from interface: Admin

Delete share groups from the cluster.

Specified by:

deleteShareGroups in interface Admin

Parameters:

groupIds - Collection of share group ids which are to be deleted.

options - The options to use when deleting a share group.

Returns:

The DeleteShareGroupsResult.

metrics

public Map<MetricName, ? extends Metric> metrics()

Description copied from interface: Admin

Get the metrics kept by the adminClient

Specified by:

metrics in interface Admin

describeCells

@Confluent
public io.confluent.kafka.clients.DescribeCellsResult describeCells(Collection<Integer> cellIds,
 io.confluent.kafka.clients.DescribeCellsOptions options)

Specified by:

describeCells in interface io.confluent.kafka.clients.CloudAdmin

describeNetwork

@Confluent
public io.confluent.kafka.clients.DescribeNetworkResult describeNetwork(String tenant,
 String listenerName,
 Collection<String> ipAddresses,
 Collection<String> clientApiKeyList,
 Collection<Integer> brokerIds,
 io.confluent.kafka.clients.DescribeNetworkOptions options)

Specified by:

describeNetwork in interface io.confluent.kafka.clients.CloudAdmin

describeCellLoad

@Confluent
public io.confluent.kafka.clients.CellLoadResult describeCellLoad(Collection<Integer> cellIds,
 io.confluent.kafka.clients.DescribeCellLoadOptions options)

Specified by:

describeCellLoad in interface io.confluent.kafka.clients.CloudAdmin

deleteCell

@Confluent
public io.confluent.kafka.clients.DeleteCellResult deleteCell(int cellId,
 io.confluent.kafka.clients.DeleteCellOptions options)

Specified by:

deleteCell in interface io.confluent.kafka.clients.CloudAdmin

createCell

@Confluent
public io.confluent.kafka.clients.CreateCellResult createCell(int cellId,
 CellState state,
 io.confluent.kafka.clients.CreateCellOptions options)

Specified by:

createCell in interface io.confluent.kafka.clients.CloudAdmin

alterCell

@Confluent
public io.confluent.kafka.clients.AlterCellResult alterCell(int cellId,
 CellState state,
 io.confluent.kafka.clients.AlterCellOptions options)

Specified by:

alterCell in interface io.confluent.kafka.clients.CloudAdmin

assignBrokersToCell

@Confluent
public io.confluent.kafka.clients.AssignBrokersToCellResult assignBrokersToCell(Collection<Integer> brokers,
 int cellId,
 boolean force,
 io.confluent.kafka.clients.AssignBrokersToCellOptions options)

Specified by:

assignBrokersToCell in interface io.confluent.kafka.clients.CloudAdmin

unassignBrokersFromCell

@Confluent
public io.confluent.kafka.clients.UnassignBrokersFromCellResult unassignBrokersFromCell(Collection<Integer> brokers,
 boolean force,
 io.confluent.kafka.clients.UnassignBrokersFromCellOptions options)

Specified by:

unassignBrokersFromCell in interface io.confluent.kafka.clients.CloudAdmin

describeTenants

@Confluent
public io.confluent.kafka.clients.DescribeTenantsResult describeTenants(Collection<String> tenantIds,
 io.confluent.kafka.clients.DescribeTenantsOptions options)

Specified by:

describeTenants in interface io.confluent.kafka.clients.CloudAdmin

deleteTenants

@Confluent
public io.confluent.kafka.clients.DeleteTenantsResult deleteTenants(Collection<String> tenantIds,
 io.confluent.kafka.clients.DeleteTenantsOptions options)

Specified by:

deleteTenants in interface io.confluent.kafka.clients.CloudAdmin

assignTenantsToCells

@Confluent
public io.confluent.kafka.clients.AssignTenantsToCellResult assignTenantsToCells(Collection<org.apache.kafka.common.message.AssignTenantsToCellRequestData.TenantToCellAssignment> assignments,
 io.confluent.kafka.clients.AssignTenantsToCellOptions options)

Specified by:

assignTenantsToCells in interface io.confluent.kafka.clients.CloudAdmin

alterCellMigration

@Confluent
public io.confluent.kafka.clients.AlterCellMigrationResult alterCellMigration(CellMigrationState state,
 io.confluent.kafka.clients.AlterCellMigrationOptions options)

Specified by:

alterCellMigration in interface io.confluent.kafka.clients.CloudAdmin

describeCellMigration

@Confluent
public io.confluent.kafka.clients.DescribeCellMigrationResult describeCellMigration(io.confluent.kafka.clients.DescribeCellMigrationOptions options)

Specified by:

describeCellMigration in interface io.confluent.kafka.clients.CloudAdmin

describeCellLoad

public io.confluent.kafka.clients.CellLoadResult describeCellLoad(Collection<Integer> cellIds)

Specified by:

describeCellLoad in interface io.confluent.kafka.clients.CloudAdmin

electLeaders

public ElectLeadersResult electLeaders(ElectionType electionType,
 Set<TopicPartition> topicPartitions,
 ElectLeadersOptions options)

Description copied from interface: Admin

Elect a replica as leader for the given partitions, or for all partitions if the argument 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, Admin.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 election 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.

Specified by:

electLeaders in interface Admin

Parameters:

electionType - The type of election to conduct.

topicPartitions - The topics and partitions for which to conduct elections.

options - The options to use when electing the leaders.

Returns:

The ElectLeadersResult.

alterPartitionReassignments

public AlterPartitionReassignmentsResult alterPartitionReassignments(Map<TopicPartition, Optional<NewPartitionReassignment>> reassignments,
 AlterPartitionReassignmentsOptions options)

Description copied from interface: Admin

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.
• InvalidReplicationFactorException If the replication factor was changed in an invalid way. Only thrown when AlterPartitionReassignmentsOptions.allowReplicationFactorChange() is set to false and the request is attempting to alter reassignments (not cancel)
• UnsupportedVersionException If AlterPartitionReassignmentsOptions.allowReplicationFactorChange() was changed outside the default and the server does not support the option (e.g due to an old Kafka version).
• NoReassignmentInProgressException If there was an attempt to cancel a reassignment for a partition which was not being reassigned.

Specified by:

alterPartitionReassignments in interface Admin

Parameters:

reassignments - The reassignments to add, modify, or remove. See NewPartitionReassignment.

options - The options to use.

Returns:

The result.

listPartitionReassignments

public ListPartitionReassignmentsResult listPartitionReassignments(Optional<Set<TopicPartition>> partitions,
 ListPartitionReassignmentsOptions options)

Specified by:

listPartitionReassignments in interface Admin

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.

replicaStatus

@Confluent
public ReplicaStatusResult replicaStatus(Set<TopicPartition> partitions,
 ReplicaStatusOptions options)

Description copied from interface: ConfluentAdmin

Retrieves the status of the replicas for a set of partitions, including observers.

The status of the replicas will be as witnessed by the partition leader. That is, the replicas themselves may be further in progress than what's provided, however the leader has not yet processed that state update.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned ReplicaStatusResult:

• TopicAuthorizationException If the authenticated user didn't have describe access to the Topic.
• UnknownTopicOrPartitionException If a given topic or partition does not exist.
• NotLeaderOrFollowerException If the partition leader changed while the request was outstanding.
• TimeoutException If the request timed out before the controller could retrieve the partition's replica status.

Specified by:

replicaStatus in interface ConfluentAdmin

Parameters:

partitions - The partitions to retrieve replica status for.

options - The options to use.

Returns:

The resulting replica status of every requested partition.

registerMetricForSubscription

public void registerMetricForSubscription(KafkaMetric metric)

Description copied from interface: Admin

Add the provided application metric for subscription. This metric will be added to this client's metrics that are available for subscription and sent as telemetry data to the broker. The provided metric must map to an OTLP metric data point type in the OpenTelemetry v1 metrics protobuf message types. Specifically, the metric should be one of the following:

• `Sum`: Monotonic total count meter (Counter). Suitable for metrics like total number of X, e.g., total bytes sent.
• `Gauge`: Non-monotonic current value meter (UpDownCounter). Suitable for metrics like current value of Y, e.g., current queue count.

Metrics not matching these types are silently ignored. Executing this method for a previously registered metric is a benign operation and results in updating that metrics entry.

Specified by:

registerMetricForSubscription in interface Admin

Parameters:

metric - The application metric to register

unregisterMetricFromSubscription

public void unregisterMetricFromSubscription(KafkaMetric metric)

Description copied from interface: Admin

Remove the provided application metric for subscription. This metric is removed from this client's metrics and will not be available for subscription any longer. Executing this method with a metric that has not been registered is a benign operation and does not result in any action taken (no-op).

Specified by:

unregisterMetricFromSubscription in interface Admin

Parameters:

metric - The application metric to remove

removeMembersFromConsumerGroup

public RemoveMembersFromConsumerGroupResult removeMembersFromConsumerGroup(String groupId,
 RemoveMembersFromConsumerGroupOptions options)

Description copied from interface: Admin

Remove members from the consumer group by given member identities.

For possible error codes, refer to LeaveGroupResponse.

Specified by:

removeMembersFromConsumerGroup in interface Admin

Parameters:

groupId - The ID of the group to remove member from.

options - The options to carry removing members' information.

Returns:

The MembershipChangeResult.

alterConsumerGroupOffsets

public AlterConsumerGroupOffsetsResult alterConsumerGroupOffsets(String groupId,
 Map<TopicPartition, OffsetAndMetadata> offsets,
 AlterConsumerGroupOffsetsOptions options)

Description copied from interface: Admin

Alters offsets for the specified group. In order to succeed, the group must be empty.

This operation is not transactional so it may succeed for some partitions while fail for others.

Specified by:

alterConsumerGroupOffsets in interface Admin

Parameters:

groupId - The group for which to alter offsets.

offsets - A map of offsets by partition with associated metadata. Partitions not specified in the map are ignored.

options - The options to use when altering the offsets.

Returns:

The AlterOffsetsResult.

alterStreamsGroupOffsets

public AlterStreamsGroupOffsetsResult alterStreamsGroupOffsets(String groupId,
 Map<TopicPartition, OffsetAndMetadata> offsets,
 AlterStreamsGroupOffsetsOptions options)

Description copied from interface: Admin

Alters offsets for the specified group. In order to succeed, the group must be empty.

This operation is not transactional so it may succeed for some partitions while fail for others. Note: this method effectively does the same as the corresponding consumer group method Admin.alterConsumerGroupOffsets(java.lang.String, java.util.Map<org.apache.kafka.common.TopicPartition, org.apache.kafka.clients.consumer.OffsetAndMetadata>) does.

Specified by:

alterStreamsGroupOffsets in interface Admin

Parameters:

groupId - The group for which to alter offsets.

offsets - A map of offsets by partition with associated metadata. Partitions not specified in the map are ignored.

options - The options to use when altering the offsets.

Returns:

The AlterOffsetsResult.

listOffsets

public ListOffsetsResult listOffsets(Map<TopicPartition, OffsetSpec> topicPartitionOffsets,
 ListOffsetsOptions options)

Description copied from interface: Admin

List offset for the specified partitions. This operation enables to find the beginning offset, end offset as well as the offset matching a timestamp in partitions.

Specified by:

listOffsets in interface Admin

Parameters:

topicPartitionOffsets - The mapping from partition to the OffsetSpec to look up.

options - The options to use when retrieving the offsets

Returns:

The ListOffsetsResult.

describeClientQuotas

public DescribeClientQuotasResult describeClientQuotas(ClientQuotaFilter filter,
 DescribeClientQuotasOptions options)

Description copied from interface: Admin

Describes all entities matching the provided filter that have at least one client quota configuration value defined.

The following exceptions can be anticipated when calling get() on the future from the returned DescribeClientQuotasResult:

• ClusterAuthorizationException If the authenticated user didn't have describe access to the cluster.
• InvalidRequestException If the request details are invalid. e.g., an invalid entity type was specified.
• TimeoutException If the request timed out before the describe could finish.

This operation is supported by brokers with version 2.6.0 or higher.

Specified by:

describeClientQuotas in interface Admin

Parameters:

filter - the filter to apply to match entities

options - the options to use

Returns:

the DescribeClientQuotasResult containing the result

alterClientQuotas

public AlterClientQuotasResult alterClientQuotas(Collection<ClientQuotaAlteration> entries,
 AlterClientQuotasOptions options)

Description copied from interface: Admin

Alters client quota configurations with the specified alterations.

Alterations for a single entity are atomic, but across entities is not guaranteed. The resulting per-entity error code should be evaluated to resolve the success or failure of all updates.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned AlterClientQuotasResult:

• ClusterAuthorizationException If the authenticated user didn't have alter access to the cluster.
• InvalidRequestException If the request details are invalid. e.g., a configuration key was specified more than once for an entity.
• TimeoutException If the request timed out before the alterations could finish. It cannot be guaranteed whether the update succeed or not.

This operation is supported by brokers with version 2.6.0 or higher.

Specified by:

alterClientQuotas in interface Admin

Parameters:

entries - the alterations to perform

Returns:

the AlterClientQuotasResult containing the result

describeUserScramCredentials

public DescribeUserScramCredentialsResult describeUserScramCredentials(List<String> users,
 DescribeUserScramCredentialsOptions options)

Description copied from interface: Admin

Describe SASL/SCRAM credentials.

The following exceptions can be anticipated when calling get() on the futures from the returned DescribeUserScramCredentialsResult:

• ClusterAuthorizationException If the authenticated user didn't have describe access to the cluster.
• ResourceNotFoundException If the user did not exist/had no SCRAM credentials.
• DuplicateResourceException If the user was requested to be described more than once in the original request.
• TimeoutException If the request timed out before the describe operation could finish.

This operation is supported by brokers with version 2.7.0 or higher.

Specified by:

describeUserScramCredentials in interface Admin

Parameters:

users - the users for which credentials are to be described; all users' credentials are described if null or empty.

options - The options to use when describing the credentials

Returns:

The DescribeUserScramCredentialsResult.

alterUserScramCredentials

public AlterUserScramCredentialsResult alterUserScramCredentials(List<UserScramCredentialAlteration> alterations,
 AlterUserScramCredentialsOptions options)

Description copied from interface: Admin

Alter SASL/SCRAM credentials.

The following exceptions can be anticipated when calling get() any of the futures from the returned AlterUserScramCredentialsResult:

• NotControllerException If the request is not sent to the Controller broker.
• ClusterAuthorizationException If the authenticated user didn't have alter access to the cluster.
• UnsupportedByAuthenticationException If the user authenticated with a delegation token.
• UnsupportedSaslMechanismException If the requested SCRAM mechanism is unrecognized or otherwise unsupported.
• UnacceptableCredentialException If the username is empty or the requested number of iterations is too small or too large.
• TimeoutException If the request timed out before the describe could finish.

This operation is supported by brokers with version 2.7.0 or higher.

Specified by:

alterUserScramCredentials in interface Admin

Parameters:

alterations - the alterations to be applied

options - The options to use when altering the credentials

Returns:

The AlterUserScramCredentialsResult.

alterBrokerReplicaExclusions

@Confluent
public AlterBrokerReplicaExclusionsResult alterBrokerReplicaExclusions(Map<Integer, ExclusionOp> operations,
 AlterBrokerReplicaExclusionsOptions options)

Description copied from interface: ConfluentAdmin

Alters the broker replica exclusions in the cluster. A replica exclusion on a broker ensures that the broker is prohibited from having any new replicas placed on it (be it from partition creation or reassignment).

Updates are atomic, meaning that the call will either succeed for all ExclusionOps or fail for all.

The following exceptions can be anticipated when calling get() on the future obtained from the returned AlterBrokerReplicaExclusionsResult:

• ClusterAuthorizationException If the authenticated user didn't have ALTER access to the cluster.
• TimeoutException If the request timed out before the controller could fetch even cluster load status.
• InvalidBrokerReplicaExclusionException If any given ExclusionOp.reason() is invalid (for the constraints, see ExclusionOp.reason()), or any other exception.
• UnrepresentableBrokerIdException If an invalid broker ID was provided.
• BrokerReplicaExclusionNotFoundException If an attempt to remove an exclusion which doesn't exist is made.

Specified by:

alterBrokerReplicaExclusions in interface ConfluentAdmin

Parameters:

operations - a map of broker ID to the desired ExclusionOp to be performed on that broker.

options - The options to use when altering the broker replica exclusions.

Returns:

The AlterBrokerReplicaExclusionsResult consisting of the attempted broker replica exclusions.

describeBrokerReplicaExclusions

@Confluent
public DescribeBrokerReplicaExclusionsResult describeBrokerReplicaExclusions(DescribeBrokerReplicaExclusionsOptions options)

Description copied from interface: ConfluentAdmin

Describes the active broker replica exclusions in the cluster. An active replica exclusion on a broker ensures that the broker is prohibited from having any new replicas placed on it (be it from partition creation or reassignment).

The following exceptions can be anticipated when calling get() on the future obtained from the returned DescribeBrokerReplicaExclusionsResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• TimeoutException If the request timed out before the controller could fetch even cluster load status.

Specified by:

describeBrokerReplicaExclusions in interface ConfluentAdmin

Parameters:

options - The options to use when describing the broker replica exclusions.

Returns:

The DescribeBrokerReplicaExclusionsResult consisting of the successfully-altered broker replica exclusions.

removeBrokers

@Confluent
public RemoveBrokersResult removeBrokers(List<Integer> brokersToRemove,
 RemoveBrokersOptions options)

Description copied from interface: ConfluentAdmin

Drain data off a given set of brokers and remove them from the cluster via shutdown. This API initiates the removal. It is suggested that the user tracks it via ConfluentAdmin.describeBrokerRemovals()

Once initiated, the brokers will be shut down and replicas will be reassigned away from them.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned RemoveBrokersResult:

ClusterAuthorizationException If we didn't have sufficient permission to initiate the broker removal. None of the requests started.

TimeoutException If the request timed out before the controller could initiate the broker removal. It cannot be guaranteed whether the removal was initiated or not.

BalancerOfflineException If the Confluent Balancer component is disabled or not started yet. Query its status with ConfluentAdmin.describeBalancerStatus() for more information

BalancerLoadError If the Confluent Balancer component failed to load. Query its status with ConfluentAdmin.describeBalancerStatus() for more information

BalancerOperationFailedException If the operation failed during execution of the removal.

InsufficientRebalancePlanMetricsException If computing the rebalance plan for broker removal failed due to insufficient metrics.

RebalancePlanComputationException If computing the rebalance plan for broker removal failed for reasons other than insufficient metrics like not enough disk space, replication factor same as the cluster size in case of broker removal etc.

InvalidBrokerRemovalException If requested broker removal operation is invalid, examples being a non-existent broker ID or some partitions (RF=1) becoming unavailable as a result of the removal.

BrokerRemovalInProgressException If the broker is already being removed.

BrokerRemovedException If the broker was already removed successfully.

BalancerBrokerExcludedForReplicaPlacementException If there are active broker replica exclusions in the cluster for brokers that are not part of the removal request. See ConfluentAdmin.describeBrokerReplicaExclusions() for more information

Specified by:

removeBrokers in interface ConfluentAdmin

Parameters:

brokersToRemove - The broker IDs to drain off partition replicas and shut down. Must not be empty.

options - The options to use for the request.

Returns:

The result of the broker removal operation.

describeBrokerAdditions

@Confluent
public DescribeBrokerAdditionsResult describeBrokerAdditions(DescribeBrokerAdditionsOptions options)

Description copied from interface: ConfluentAdmin

Describes all the broker additions in the cluster.

Note that broker additions can be interrupted by subsequent higher-priority operations (e.g broker removal operations, even if operating on different brokers).

A broker addition's partition reassignment task can be in one of multiple statuses: 1. PartitionReassignmentsStatus.ERROR - when the broker addition operation failed midway 2. PartitionReassignmentsStatus.PENDING - when the intent of addition is registered but the balancer is yet to start on it (e.g still collecting metrics) 3. PartitionReassignmentsStatus.CANCELED - when the addition is canceled (e.g due to a higher priority operation coming through) 4. PartitionReassignmentsStatus.IN_PROGRESS - when the addition is in progress (replicas are being reassigned) 5. PartitionReassignmentsStatus.COMPLETED - when the broker has successfully been added to the cluster

The operation's status is also exposed through the general #BalancerOperationStatus, which can be in one of the following statuses: 1. #BalancerOperationStatus.FAILED - when the operation has ceased before completing due to an external influence canceling it or an internal error failing it. 2. #BalancerOperationStatus.IN_PROGRESS - when the intent of the operation is registered and is in the process of being completed. 3. #BalancerOperationStatus.SUCCESS - when the balancer operation has completed successfully.

Additionally, each broker addition exposes a #BrokerAdditionDescription.additionError() that provides additional context regarding the reason the operation is in the given status

The following exceptions can be anticipated when calling get() on the futures obtained from the returned DescribeBrokerAdditionsResult:

• BalancerOfflineException If the Confluent Balancer component is disabled or not started yet. Query its status with ConfluentAdmin.describeBalancerStatus() for more information
• BalancerLoadError If the Confluent Balancer component failed to load. Query its status with ConfluentAdmin.describeBalancerStatus() for more information
• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• TimeoutException If the request timed out before the controller could describe the removals.

Specified by:

describeBrokerAdditions in interface ConfluentAdmin

Parameters:

options - The options to use when describing the broker additions

Returns:

The DescribeBrokerAdditionsResult

describeBrokerRemovals

@Confluent
public DescribeBrokerRemovalsResult describeBrokerRemovals(DescribeBrokerRemovalsOptions options)

Description copied from interface: ConfluentAdmin

Describes all the broker removals in the cluster. Note that a removal is considered cleared once a broker starts up with 0 partitions.

A broker removal consists of broker shutdown and partition reassignments that move all replicas the now-shutdown broker hosted away from it. The status of the removal is tracked by two separate status fields: 1. #BrokerRemovalDescription.shutdownStatus(), a #BrokerShutdownStatus denoting the status of the shutdown operation 2. #BrokerRemovalDescription.reassignmentsStatus(), a #PartitionReassignmentsStatus denoting the status of the partition reassignments operation

When at least one of the two has a failed status, the broker removal operation is considered failed. The user is expected to retry the removal via #ConfluentAdmin.removeBrokers(List).

When both have a completed status, the broker removal operation is considered a success.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned DescribeBrokerRemovalsResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• TimeoutException If the request timed out before the controller could describe the removals.
• BalancerOfflineException If the Confluent Balancer component is disabled or not started yet. Query its status with ConfluentAdmin.describeBalancerStatus() for more information
• BalancerLoadError If the Confluent Balancer component failed to load. Query its status with ConfluentAdmin.describeBalancerStatus() for more information

Specified by:

describeBrokerRemovals in interface ConfluentAdmin

Parameters:

options - The options to use when describing the broker removals.

Returns:

The DescribeBrokerRemovalResult.

describeBalancerStatus

@Confluent
public DescribeBalancerStatusResult describeBalancerStatus(DescribeBalancerStatusOptions options)

Description copied from interface: ConfluentAdmin

Describes status of confluent balancer component. The Confluent Balancer can have one of the state from BalancerStatus.

In addition to the status field, the #BalancerStatusDescription.balancerOperationError() gives context about the status of the balancer, e.g. why the balancer is in error state etc.

The following exceptions can be anticipated when calling get() on the future obtained from the returned DescribeBalancerStatusResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• TimeoutException If the request timed out before the controller could fetch balancer status.

Specified by:

describeBalancerStatus in interface ConfluentAdmin

Parameters:

options - The options to use when fetching the balancer status.

Returns:

The DescribeBalancerStatusResult

triggerEvenClusterLoad

public TriggerEvenClusterLoadResult triggerEvenClusterLoad(List<String> goalList,
 TriggerEvenClusterLoadOptions options)

Description copied from interface: ConfluentAdmin

Triggers the even cluster load operation.

If ConfluentConfigs.BALANCER_AUTO_HEAL_MODE_CONFIG is configured to ConfluentConfigs.BalancerSelfHealMode.ANY_UNEVEN_LOAD, then Confluent Balancer is continuously monitoring the cluster and determining whether it can improve the balance of the cluster's load. This API helps manually trigger the operation.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned TriggerEvenClusterLoadResult:

ClusterAuthorizationException If we didn't have sufficient permission to request rebalance. The request would not be started.

TimeoutException If the request timed out as no response was received from the controller, possible reasons could be request was faulted or response being dropped due to some network issue etc. The status of the even cluster load is unknown in this case.

BalancerOfflineException If the Confluent Balancer component is disabled or not started yet. Query its status with ConfluentAdmin.describeBalancerStatus() for more information

BalancerLoadError If the Confluent Balancer component failed to load. Query its status with ConfluentAdmin.describeBalancerStatus() for more information

BrokerRemovalInProgressException If a broker removal operation is in progress.

BrokerAdditionInProgressException If a broker addition operation is in progress.

EvenClusterLoadTaskInProgressException If an even cluster load operation is already in progress.

Specified by:

triggerEvenClusterLoad in interface ConfluentAdmin

Parameters:

goalList - The list of goals to use for manual rebalance, or an empty list for default goals

options - The options to use for the request.

Returns:

The result of the even cluster load request whether it was accepted or denied.

computeEvenClusterLoadPlan

@Confluent
public ComputeEvenClusterLoadPlanResult computeEvenClusterLoadPlan(List<String> goalList,
 ComputeEvenClusterLoadPlanOptions options)

Description copied from interface: ConfluentAdmin

Compute and return an even cluster load plan for the cluster based on the rebalance goals.

The following exceptions can be anticipated for when calling get() on the futures obtained from the returned ComputeEvenClusterLoadPlanResult:

ClusterAuthorizationException If we didn't have sufficient permission to request rebalance plan. The request would not be started.

TimeoutException If the request timed out as no response was received from the controller, possible reasons could be request was faulted or response being dropped due to some network issue etc.

BalancerOfflineException If the Confluent Balancer component is disabled or not started yet. Query its status with ConfluentAdmin.describeBalancerStatus() for more information.

BalancerLoadError If the Confluent Balancer component failed to load. Query its status with ConfluentAdmin.describeBalancerStatus() for more information.

BrokerRemovalInProgressException If a broker removal operation is in progress.

BrokerAdditionInProgressException If a broker addition operation is in progress.

EvenClusterLoadTaskInProgressException If an even cluster load operation is in progress.

BrokerFailureFixInProgressException If there's an ongoing broker failure anomaly fix.

RebalancePlanComputationException If there's an issue with SBC's plan computation process.

Specified by:

computeEvenClusterLoadPlan in interface ConfluentAdmin

Parameters:

goalList - The list of goals to use for manual rebalance, or an empty list for default goals

options - The options to use for the request.

Returns:

The result of the even cluster load plan computation.

describeEvenClusterLoadStatus

public DescribeEvenClusterLoadStatusResult describeEvenClusterLoadStatus(DescribeEvenClusterLoadStatusOptions options)

Description copied from interface: ConfluentAdmin

Describe the status of the even cluster load operation.

If enabled, Confluent Balancer is continuously monitoring the cluster and determining whether it can improve the balance of the cluster's load. This API helps describe the status of the operation.

The following exceptions can be anticipated when calling get() on the future obtained from the returned DescribeEvenClusterLoadStatusResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• TimeoutException If the request timed out before the controller could fetch even cluster load status.

Specified by:

describeEvenClusterLoadStatus in interface ConfluentAdmin

Parameters:

options - The options to use when fetching the even cluster load status.

Returns:

The DescribeEvenClusterLoadStatusResult

createClusterLinks

@Confluent
public CreateClusterLinksResult createClusterLinks(Collection<NewClusterLink> clusterLinks,
 CreateClusterLinksOptions options)

Description copied from interface: ConfluentAdmin

Creates links to remote clusters with the specified configurations for performing inter-cluster communications. Once established, the cluster links can referenced by their link names for issuing requests. The following exceptions can be anticipated when calling get() on the futures obtained from the returned CreateClusterLinksResult:

• BalancerOfflineException If the Confluent Balancer component is disabled or not started yet. Query its status with ConfluentAdmin.describeBalancerStatus() for more information
• BalancerLoadError If the Confluent Balancer component failed to load. Query its status with ConfluentAdmin.describeBalancerStatus() for more information
• InvalidClusterLinkException If the cluster link name is illegal.
• ClusterAuthorizationException If the authenticated user didn't have CREATE access to the cluster.
• ClusterLinkExistsException If a cluster link already exists for the provided link name.
• TimeoutException If the request timed out before the controller could create the cluster link.

Specified by:

createClusterLinks in interface ConfluentAdmin

Parameters:

clusterLinks - The cluster links to create.

options - The options to use when creating the cluster links.

Returns:

The CreateClusterLinksResult.

listClusterLinks

@Confluent
public ListClusterLinksResult listClusterLinks(ListClusterLinksOptions options)

Description copied from interface: ConfluentAdmin

Lists the cluster links.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned ListClusterLinksResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• TimeoutException If the request timed out before the controller could list the cluster links.

Specified by:

listClusterLinks in interface ConfluentAdmin

Parameters:

options - The options to use when listing the cluster links.

Returns:

The ListClusterLinksResult.

describeClusterLinks

@Confluent
public DescribeClusterLinksResult describeClusterLinks(DescribeClusterLinksOptions options)

Description copied from interface: ConfluentAdmin

Describe the cluster links.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned DescribeClusterLinksResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• NotControllerException If the Kafka broker is not a controller.
• ClusterLinkDisabledException If cluster link is disabled.
• TimeoutException If the request timed out before the controller could list the cluster links.

Specified by:

describeClusterLinks in interface ConfluentAdmin

Parameters:

options - The options to use when describing the cluster links. When no link name is provided, all the cluster links descriptions will be returned.

Returns:

The DescribeClusterLinksResult.

describeClusterLinksToController

public void describeClusterLinksToController(DescribeClusterLinksOptions options,
 org.apache.kafka.common.internals.KafkaFutureImpl<Collection<ClusterLinkDescription>> result,
 long now)

deleteClusterLinks

@Confluent
public DeleteClusterLinksResult deleteClusterLinks(Collection<String> linkNames,
 DeleteClusterLinksOptions options)

Description copied from interface: ConfluentAdmin

Deletes established links to remote clusters with the provided link names.

Deleting a cluster link does not affect the cluster link's data in any way.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned DeleteClusterLinksResult:

• InvalidClusterLinkException If the cluster link name is illegal.
• ClusterAuthorizationException If the authenticated user didn't have DELETE access to the cluster.
• ClusterLinkNotFoundException If the cluster link to delete doesn't exist.
• TimeoutException If the request timed out before the controller could delete the cluster link.

Specified by:

deleteClusterLinks in interface ConfluentAdmin

Parameters:

linkNames - The names of the cluster links to delete.

options - The options to use when deleting the cluster links.

Returns:

The DeleteClusterLinksResult.

alterMirrors

@Confluent
public AlterMirrorsResult alterMirrors(Map<String, AlterMirrorOp> ops,
 AlterMirrorsOptions options)

Description copied from interface: ConfluentAdmin

Performs a state alteration for topic mirroring. Used only for operations on mirror topics.

The future of the individual alter mirror ops should be used for obtaining the result.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned AlterMirrorsResult:

• TopicAuthorizationException If the authenticated user didn't have ALTER access to the topic.
• TimeoutException If the request timed out before the controller could complete the mirror operation.

Specified by:

alterMirrors in interface ConfluentAdmin

Parameters:

ops - The mirror alteration operation for each topic.

options - The options to use when altering mirrors.

Returns:

The AlterMirrorsResult.

listMirrors

@Confluent
public ListMirrorsResult listMirrors(ListMirrorsOptions options)

Description copied from interface: ConfluentAdmin

Lists the mirrored topics, i.e. topics that are mirrors of another over a cluster link.

The following exceptions can be anticipated when calling get() on the future obtained from the returned ListMirrorsResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• ClusterLinkNotFoundException If a specific cluster link was requested and the cluster link doesn't exist.
• TimeoutException If the request timed out before the controller could complete the operation.

Specified by:

listMirrors in interface ConfluentAdmin

Parameters:

options - The options to use when listing mirrors.

Returns:

The ListMirrorsResult.

describeMirrors

@Confluent
public DescribeMirrorsResult describeMirrors(Collection<String> topics,
 DescribeMirrorsOptions options)

Description copied from interface: ConfluentAdmin

Describes the state of mirrored topics, i.e. topics that are mirrors of another over a cluster link.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned DescribeMirrorsResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• TimeoutException If the request timed out before the controller could complete the operation.

Specified by:

describeMirrors in interface ConfluentAdmin

Parameters:

options - The options to use when describing mirrors.

Returns:

The DescribeMirrorsResult.

describeMirrorsToController

public DescribeMirrorsResult describeMirrorsToController(DescribeMirrorsOptions options,
 Map<String, org.apache.kafka.common.internals.KafkaFutureImpl<MirrorTopicDescription>> result,
 Long now)

describeSwitchoverStatus

@Confluent
public DescribeSwitchoverStatusResult describeSwitchoverStatus(String linkName)

Description copied from interface: ConfluentAdmin

Describe the cluster link switchover status.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned DescribeSwitchoverStatusResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• ClusterLinkDisabledException If cluster link is disabled.
• TimeoutException If the request timed out before the controller could list the cluster links.

Specified by:

describeSwitchoverStatus in interface ConfluentAdmin

Parameters:

linkName - The link name of the cluster

Returns:

The DescribeSwitchoverStatusResult.

alterBrokerHealth

@Confluent
public AlterBrokerHealthResult alterBrokerHealth(AlterBrokerHealthSpec data,
 AlterBrokerHealthOptions options)

Specified by:

alterBrokerHealth in interface io.confluent.kafka.clients.CloudAdmin

describeBrokerHealth

@Confluent
public DescribeBrokerHealthResult describeBrokerHealth(DescribeBrokerHealthOptions options)

Specified by:

describeBrokerHealth in interface io.confluent.kafka.clients.CloudAdmin

describeFeatures

public DescribeFeaturesResult describeFeatures(DescribeFeaturesOptions options)

Description copied from interface: Admin

Describes finalized as well as supported features. The request is issued to any random broker.

The following exceptions can be anticipated when calling get() on the future from the returned DescribeFeaturesResult:

• TimeoutException If the request timed out before the describe operation could finish.

Specified by:

describeFeatures in interface Admin

Parameters:

options - the options to use

Returns:

the DescribeFeaturesResult containing the result

updateFeatures

public UpdateFeaturesResult updateFeatures(Map<String, FeatureUpdate> featureUpdates,
 UpdateFeaturesOptions options)

Description copied from interface: Admin

Applies specified updates to finalized features. This operation is not transactional so some updates may succeed while the rest may fail.

The API takes in a map of finalized feature names to FeatureUpdate that needs to be applied. Each entry in the map specifies the finalized feature to be added or updated or deleted, along with the new max feature version level value. This request is issued only to the controller since the API is only served by the controller. The return value contains an error code for each supplied FeatureUpdate, and the code indicates if the update succeeded or failed in the controller.

• Downgrading a feature version level is not a common operation and should only be performed when necessary. It is permitted only if the FeatureUpdate specifies the upgradeType as either FeatureUpdate.UpgradeType.SAFE_DOWNGRADE or FeatureUpdate.UpgradeType.UNSAFE_DOWNGRADE.
  • SAFE_DOWNGRADE: Allows downgrades that do not lead to metadata loss.
  • UNSAFE_DOWNGRADE: Permits downgrades that might result in metadata loss.
  Note that even with these settings, certain downgrades may still be rejected by the controller if they are considered unsafe or impossible.
• Deleting a finalized feature version is also not a common operation. To delete a feature, set the maxVersionLevel to zero and specify the upgradeType as either FeatureUpdate.UpgradeType.SAFE_DOWNGRADE or FeatureUpdate.UpgradeType.UNSAFE_DOWNGRADE.
• The FeatureUpdate.UpgradeType.UPGRADE type cannot be used when the maxVersionLevel is zero. Attempting to do so will result in an IllegalArgumentException.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned UpdateFeaturesResult:

• ClusterAuthorizationException If the authenticated user didn't have alter access to the cluster.
• InvalidRequestException If the request details are invalid. e.g., a non-existing finalized feature is attempted to be deleted or downgraded.
• TimeoutException If the request timed out before the updates could finish. It cannot be guaranteed whether the updates succeeded or not.
• FeatureUpdateFailedException This means there was an unexpected error encountered when the update was applied on the controller. There is no guarantee on whether the update succeeded or failed. The best way to find out is to issue a Admin.describeFeatures(DescribeFeaturesOptions) request.

This operation is supported by brokers with version 2.7.0 or higher.

Specified by:

updateFeatures in interface Admin

Parameters:

featureUpdates - the map of finalized feature name to FeatureUpdate

options - the options to use

Returns:

the UpdateFeaturesResult containing the result

describeMetadataQuorum

public DescribeMetadataQuorumResult describeMetadataQuorum(DescribeMetadataQuorumOptions options)

Description copied from interface: Admin

Describes the state of the metadata quorum.

The following exceptions can be anticipated when calling get() on the futures obtained from the returned DescribeMetadataQuorumResult:

• ClusterAuthorizationException If the authenticated user didn't have DESCRIBE access to the cluster.
• TimeoutException If the request timed out before the controller could list the cluster links.

Specified by:

describeMetadataQuorum in interface Admin

Parameters:

options - The DescribeMetadataQuorumOptions to use when describing the quorum.

Returns:

the DescribeMetadataQuorumResult containing the result

unregisterBroker

public UnregisterBrokerResult unregisterBroker(int brokerId,
 UnregisterBrokerOptions options)

Description copied from interface: Admin

Unregister a broker.

This operation does not have any effect on partition assignments. The following exceptions can be anticipated when calling get() on the future from the returned UnregisterBrokerResult:

• TimeoutException If the request timed out before the describe operation could finish.
• UnsupportedVersionException If the software is too old to support the unregistration API.

Specified by:

unregisterBroker in interface Admin

Parameters:

brokerId - the broker id to unregister.

options - the options to use.

Returns:

the UnregisterBrokerResult containing the result

describeProducers

public DescribeProducersResult describeProducers(Collection<TopicPartition> topicPartitions,
 DescribeProducersOptions options)

Description copied from interface: Admin

Describe active producer state on a set of topic partitions. Unless a specific broker is requested through DescribeProducersOptions.brokerId(int), this will query the partition leader to find the producer state.

Specified by:

describeProducers in interface Admin

Parameters:

topicPartitions - The set of partitions to query

options - Options to control the method behavior

Returns:

The result

describeTransactions

public DescribeTransactionsResult describeTransactions(Collection<String> transactionalIds,
 DescribeTransactionsOptions options)

Description copied from interface: Admin

Describe the state of a set of transactional IDs from the respective transaction coordinators, which are dynamically discovered.

Specified by:

describeTransactions in interface Admin

Parameters:

transactionalIds - The set of transactional IDs to query

options - Options to control the method behavior

Returns:

The result

abortTransaction

public AbortTransactionResult abortTransaction(AbortTransactionSpec spec,
 AbortTransactionOptions options)

Description copied from interface: Admin

Forcefully abort a transaction which is open on a topic partition. This will send a `WriteTxnMarkers` request to the partition leader in order to abort the transaction. This requires administrative privileges.

Specified by:

abortTransaction in interface Admin

Parameters:

spec - The transaction specification including topic partition and producer details

options - Options to control the method behavior (including filters)

Returns:

The result

forceTerminateTransaction

public TerminateTransactionResult forceTerminateTransaction(String transactionalId,
 TerminateTransactionOptions options)

Forcefully terminates an ongoing transaction for a given transactional ID.

This API is intended for well-formed but long-running transactions that are known to the transaction coordinator. It is primarily designed for supporting 2PC (two-phase commit) workflows, where a coordinator may need to unilaterally terminate a participant transaction that hasn't completed.

Specified by:

forceTerminateTransaction in interface Admin

Parameters:

transactionalId - The transactional ID whose active transaction should be forcefully terminated.

options - The options to use when terminating the transaction.

Returns:

a TerminateTransactionResult that can be used to await the operation result.

listTransactions

public ListTransactionsResult listTransactions(ListTransactionsOptions options)

Description copied from interface: Admin

List active transactions in the cluster. This will query all potential transaction coordinators in the cluster and collect the state of all transactions. Users should typically attempt to reduce the size of the result set using ListTransactionsOptions.filterProducerIds(Collection) or ListTransactionsOptions.filterStates(Collection) or ListTransactionsOptions.filterOnDuration(long).

Specified by:

listTransactions in interface Admin

Parameters:

options - Options to control the method behavior (including filters)

Returns:

The result

fenceProducers

public FenceProducersResult fenceProducers(Collection<String> transactionalIds,
 FenceProducersOptions options)

Description copied from interface: Admin

Fence out all active producers that use any of the provided transactional IDs.

Specified by:

fenceProducers in interface Admin

Parameters:

transactionalIds - The IDs of the producers to fence.

options - The options to use when fencing the producers.

Returns:

The FenceProducersResult.

listConfigResources

public ListConfigResourcesResult listConfigResources(Set<ConfigResource.Type> configResourceTypes,
 ListConfigResourcesOptions options)

Description copied from interface: Admin

List the configuration resources available in the cluster which matches config resource type. If no config resource types are specified, all configuration resources will be listed.

Specified by:

listConfigResources in interface Admin

Parameters:

configResourceTypes - The set of configuration resource types to list.

options - The options to use when listing the configuration resources.

Returns:

The ListConfigurationResourcesResult.

listClientMetricsResources

public ListClientMetricsResourcesResult listClientMetricsResources(ListClientMetricsResourcesOptions options)

Description copied from interface: Admin

List the client metrics configuration resources available in the cluster.

Specified by:

listClientMetricsResources in interface Admin

Parameters:

options - The options to use when listing the client metrics resources.

Returns:

The ListClientMetricsResourcesResult.

addRaftVoter

public AddRaftVoterResult addRaftVoter(int voterId,
 Uuid voterDirectoryId,
 Set<RaftVoterEndpoint> endpoints,
 AddRaftVoterOptions options)

Description copied from interface: Admin

Add a new voter node to the KRaft metadata quorum.

The clusterId in AddRaftVoterOptions is optional. If provided, the operation will only succeed if the cluster id matches the id of the current cluster. If the cluster id does not match, the operation will fail with InconsistentClusterIdException. If not provided, the cluster id check is skipped.

Specified by:

addRaftVoter in interface Admin

Parameters:

voterId - The node ID of the voter.

voterDirectoryId - The directory ID of the voter.

endpoints - The endpoints that the new voter has.

options - Additional options for the operation, including optional cluster ID.

removeRaftVoter

public RemoveRaftVoterResult removeRaftVoter(int voterId,
 Uuid voterDirectoryId,
 RemoveRaftVoterOptions options)

Description copied from interface: Admin

Remove a voter node from the KRaft metadata quorum.

The clusterId in RemoveRaftVoterOptions is optional. If provided, the operation will only succeed if the cluster id matches the id of the current cluster. If the cluster id does not match, the operation will fail with InconsistentClusterIdException. If not provided, the cluster id check is skipped.

Specified by:

removeRaftVoter in interface Admin

Parameters:

voterId - The node ID of the voter.

voterDirectoryId - The directory ID of the voter.

options - Additional options for the operation, including optional cluster ID.

clientInstanceId

public Uuid clientInstanceId(Duration timeout)

Description copied from interface: Admin

Determines the client's unique client instance ID used for telemetry. This ID is unique to this specific client instance and will not change after it is initially generated. The ID is useful for correlating client operations with telemetry sent to the broker and to its eventual monitoring destinations.

If telemetry is enabled, this will first require a connection to the cluster to generate the unique client instance ID. This method waits up to timeout for the admin client to complete the request.

Client telemetry is controlled by the AdminClientConfig.ENABLE_METRICS_PUSH_CONFIG configuration option.

Specified by:

clientInstanceId in interface Admin

Parameters:

timeout - The maximum time to wait for admin client to determine its client instance ID. The value must be non-negative. Specifying a timeout of zero means do not wait for the initial request to complete if it hasn't already.

Returns:

The client's assigned instance id used for metrics collection.

reportClusterLinkStatus

public ReportClusterLinkStatusResult reportClusterLinkStatus(Integer publisherBrokerId,
 Collection<org.apache.kafka.common.requests.ReportClusterLinkStatusRequest.ClusterLinkMirrorState> linkMirrorStates,
 ReportClusterLinkStatusOptions options)

Internal method to report Cluster Link Status. This method is invoked using ConfluentAdminUtils.