Deprecated API

Contents

• Deprecated Packages
• Deprecated Classes
• Deprecated Exceptions
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Packages

Package and Description
org.apache.kafka.common.security.oauthbearer.secured See org.apache.kafka.common.security.oauthbearer

Deprecated Classes

Class and Description
org.apache.kafka.common.KafkaFuture.Function Since Kafka 3.0. Use the KafkaFuture.BaseFunction functional interface.
org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler See org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginCallbackHandler
org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerValidatorCallbackHandler See org.apache.kafka.common.security.oauthbearer.OAuthBearerValidatorCallbackHandler
org.apache.kafka.clients.producer.UniformStickyPartitioner

Deprecated Exceptions

Exceptions and Description
org.apache.kafka.common.errors.NotLeaderForPartitionException since 2.6. Use NotLeaderOrFollowerException.

Deprecated Fields

Field and Description
org.apache.kafka.clients.producer.ProducerConfig.AUTO_INCLUDE_JMX_REPORTER_CONFIG
org.apache.kafka.clients.consumer.ConsumerConfig.AUTO_INCLUDE_JMX_REPORTER_CONFIG
org.apache.kafka.clients.admin.AdminClientConfig.AUTO_INCLUDE_JMX_REPORTER_CONFIG
org.apache.kafka.common.config.TopicConfig.MESSAGE_FORMAT_VERSION_CONFIG since 3.0, removal planned in 4.0. The default value for this config is appropriate for most situations.
org.apache.kafka.common.config.TopicConfig.MESSAGE_FORMAT_VERSION_DOC since 3.0, removal planned in 4.0. The default value for this config is appropriate for most situations.
org.apache.kafka.clients.consumer.ConsumerRecord.NULL_CHECKSUM checksums are no longer exposed by this class, this constant will be removed in Apache Kafka 4.0 (deprecated since 3.0).

Deprecated Methods

Method and Description
org.apache.kafka.clients.admin.DescribeTopicsResult.all() Since 3.1.0 use DescribeTopicsResult.allTopicNames() instead
org.apache.kafka.clients.admin.DescribeLogDirsResult.all() Deprecated Since Kafka 2.7. Use DescribeLogDirsResult.allDescriptions().
org.apache.kafka.clients.admin.FeatureUpdate.allowDowngrade()
org.apache.kafka.clients.admin.Admin.alterConfigs(Map<ConfigResource, Config>) Since 2.3. Use Admin.incrementalAlterConfigs(Map).
org.apache.kafka.clients.admin.ForwardingAdmin.alterConfigs(Map<ConfigResource, Config>, AlterConfigsOptions)
org.apache.kafka.clients.admin.KafkaAdminClient.alterConfigs(Map<ConfigResource, Config>, AlterConfigsOptions)
org.apache.kafka.clients.admin.Admin.alterConfigs(Map<ConfigResource, Config>, AlterConfigsOptions) Since 2.3. Use Admin.incrementalAlterConfigs(Map, AlterConfigsOptions).
org.apache.kafka.clients.consumer.KafkaConsumer.committed(TopicPartition) since 2.4 Use KafkaConsumer.committed(Set) instead
org.apache.kafka.clients.consumer.MockConsumer.committed(TopicPartition)
org.apache.kafka.clients.consumer.Consumer.committed(TopicPartition)
org.apache.kafka.clients.consumer.KafkaConsumer.committed(TopicPartition, Duration) since 2.4 Use KafkaConsumer.committed(Set, Duration) instead
org.apache.kafka.clients.consumer.MockConsumer.committed(TopicPartition, Duration)
org.apache.kafka.clients.consumer.Consumer.committed(TopicPartition, Duration)
org.apache.kafka.clients.admin.UpdateFeaturesOptions.dryRun()
org.apache.kafka.clients.admin.UpdateFeaturesOptions.dryRun(boolean)
org.apache.kafka.clients.admin.MirrorTopicDescription.linkId()
org.apache.kafka.clients.admin.ClusterLinkListing.linkId()
org.apache.kafka.clients.admin.NewMirrorTopic.mirrorTopic() This method is being deprecated because mirrorTopic is not an accurate name to describe a method that returns the source topic's name. Use NewMirrorTopic.sourceTopic()} instead.
org.apache.kafka.clients.admin.MirrorTopicDescription.mirrorTopic()
org.apache.kafka.clients.producer.Partitioner.onNewBatch(String, Cluster, int)
org.apache.kafka.clients.consumer.KafkaConsumer.poll(long) Since 2.0. Use KafkaConsumer.poll(Duration), which does not block beyond the timeout awaiting partition assignment. See KIP-266 for more information.
org.apache.kafka.clients.consumer.MockConsumer.poll(long)
org.apache.kafka.clients.consumer.Consumer.poll(long)
org.apache.kafka.clients.producer.MockProducer.sendOffsetsToTransaction(Map<TopicPartition, OffsetAndMetadata>, String)
org.apache.kafka.clients.producer.KafkaProducer.sendOffsetsToTransaction(Map<TopicPartition, OffsetAndMetadata>, String) Since 3.0.0, please use KafkaProducer.sendOffsetsToTransaction(Map, ConsumerGroupMetadata) instead.
org.apache.kafka.clients.producer.Producer.sendOffsetsToTransaction(Map<TopicPartition, OffsetAndMetadata>, String)
org.apache.kafka.clients.consumer.MockConsumer.setException(KafkaException) Use MockConsumer.setPollException(KafkaException) instead
org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions.topicPartitions() Since 3.3. Use Admin.listConsumerGroupOffsets(java.util.Map, ListConsumerGroupOffsetsOptions) to specify topic partitions.
org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions.topicPartitions(List<TopicPartition>) Since 3.3. Use Admin.listConsumerGroupOffsets(java.util.Map, ListConsumerGroupOffsetsOptions) to specify topic partitions.
org.apache.kafka.clients.admin.DescribeTopicsResult.values() Since 3.1.0 use DescribeTopicsResult.topicNameValues() instead
org.apache.kafka.clients.admin.DescribeLogDirsResult.values() Deprecated Since Kafka 2.7. Use DescribeLogDirsResult.descriptions().
org.apache.kafka.clients.admin.DeleteTopicsResult.values() Since 3.0 use DeleteTopicsResult.topicNameValues() instead

Deprecated Constructors

Constructor and Description
org.apache.kafka.clients.admin.BrokerRemovalDescription(Integer, BalancerOperationStatus, BrokerShutdownStatus, PartitionReassignmentsStatus, Optional<BrokerRemovalError>, long, long)
org.apache.kafka.clients.admin.ClusterLinkDescription(String, Uuid, String, String, Collection<String>, ClusterLinkDescription.LinkState, ClusterLinkDescription.LinkMode, ClusterLinkDescription.ConnectionMode)
org.apache.kafka.clients.admin.ClusterLinkListing(String, Uuid, String, String, Optional<Collection<String>>, boolean)
org.apache.kafka.clients.admin.ClusterLinkListing(String, UUID, String, String, Optional<Collection<String>>, boolean)
org.apache.kafka.clients.admin.ClusterLinkListing(String, UUID, String, String, Optional<Collection<String>>, boolean, ClusterLinkError, String)
org.apache.kafka.clients.consumer.ConsumerRecord(String, int, long, long, TimestampType, long, int, int, K, V) use one of the constructors without a `checksum` parameter. This constructor will be removed in Apache Kafka 4.0 (deprecated since 3.0).
org.apache.kafka.clients.consumer.ConsumerRecord(String, int, long, long, TimestampType, Long, int, int, K, V, Headers) use one of the constructors without a `checksum` parameter. This constructor will be removed in Apache Kafka 4.0 (deprecated since 3.0).
org.apache.kafka.clients.consumer.ConsumerRecord(String, int, long, long, TimestampType, Long, int, int, K, V, Headers, Optional<Integer>) use one of the constructors without a `checksum` parameter. This constructor will be removed in Apache Kafka 4.0 (deprecated since 3.0).
org.apache.kafka.clients.admin.DescribeTopicsResult(Map<String, KafkaFuture<TopicDescription>>)
org.apache.kafka.clients.admin.EvenClusterLoadPlanGoalStatsResources(double, double, double, double, double, int, int, int) since 7.4.0; prefer the other constructor EvenClusterLoadPlanGoalStatsResources(double, double, double, double, double, double, int, int, int) since it includes the producerInboundKBps
org.apache.kafka.clients.admin.FeatureUpdate(short, boolean)
org.apache.kafka.common.metrics.JmxReporter(String) Since 2.6.0. Use JmxReporter() Initialize JmxReporter with JmxReporter.contextChange(MetricsContext) Populate prefix by adding _namespace/prefix key value pair to MetricsContext
org.apache.kafka.clients.admin.MirrorTopicDescription(String, Uuid, String, int, MirrorTopicDescription.State, long, List<Long>)
org.apache.kafka.clients.admin.MirrorTopicDescription(String, UUID, String, int, MirrorTopicDescription.State, long, List<Long>)
org.apache.kafka.clients.producer.RecordMetadata(TopicPartition, long, long, long, Long, int, int) use constructor without `checksum` parameter. This constructor will be removed in Apache Kafka 4.0 (deprecated since 3.0).
org.apache.kafka.clients.admin.TopicListing(String, boolean) Since 3.0 use TopicListing(String, Uuid, boolean) instead

Deprecated Enum Constants

Enum Constant and Description
org.apache.kafka.clients.admin.EvenClusterLoadStatus.DISABLED since 7.3.0