Deprecated API

Contents

• Terminally Deprecated
• Interfaces
• Classes
• Enum Classes
• Fields
• Methods
• Constructors

Terminally Deprecated Elements

Element	Description
org.apache.kafka.clients.admin.Admin.listClientMetricsResources()	Since 4.1. Use Admin.listConfigResources() instead.
org.apache.kafka.clients.admin.Admin.listClientMetricsResources(ListClientMetricsResourcesOptions)	Since 4.1. Use Admin.listConfigResources(Set, ListConfigResourcesOptions) instead.
org.apache.kafka.clients.admin.Admin.listConsumerGroups()	Since 4.1. Use Admin.listGroups(ListGroupsOptions) instead.
org.apache.kafka.clients.admin.Admin.listConsumerGroups(ListConsumerGroupsOptions)	Since 4.1. Use Admin.listGroups(ListGroupsOptions) instead.
org.apache.kafka.clients.admin.ConsumerGroupDescription(String, boolean, Collection<MemberDescription>, String, ConsumerGroupState, Node)	Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.
org.apache.kafka.clients.admin.ConsumerGroupDescription(String, boolean, Collection<MemberDescription>, String, ConsumerGroupState, Node, Set<AclOperation>)	Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.
org.apache.kafka.clients.admin.ConsumerGroupDescription(String, boolean, Collection<MemberDescription>, String, GroupType, ConsumerGroupState, Node, Set<AclOperation>)	Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.
org.apache.kafka.clients.admin.ConsumerGroupDescription.state()	Since 4.0. Use ConsumerGroupDescription.groupState() instead.
org.apache.kafka.clients.admin.ConsumerGroupListing	Since 4.1. Use Admin.listGroups(ListGroupsOptions) and GroupListing instead.
org.apache.kafka.clients.admin.KafkaAdminClient.listConsumerGroups(ListConsumerGroupsOptions)
org.apache.kafka.clients.admin.MemberDescription(String, String, String, MemberAssignment)	Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.
org.apache.kafka.clients.admin.MemberDescription(String, Optional<String>, String, String, MemberAssignment)	Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.
org.apache.kafka.clients.admin.MemberDescription(String, Optional<String>, String, String, MemberAssignment, Optional<MemberAssignment>)	Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.
org.apache.kafka.clients.admin.MemberDescription(String, Optional<String>, String, String, MemberAssignment, Optional<MemberAssignment>, Optional<Integer>, Optional<Boolean>)	Since 4.2. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.
org.apache.kafka.clients.admin.RaftVoterEndpoint.name()	Since 4.1. Use RaftVoterEndpoint.listener() instead. This function will be removed in 5.0.
org.apache.kafka.clients.consumer.ConsumerGroupMetadata(String)	Since 4.2, please use KafkaConsumer.groupMetadata() instead. This class will be an interface in Kafka 5.0.
org.apache.kafka.clients.consumer.ConsumerGroupMetadata(String, int, String, Optional<String>)	Since 4.2, please use KafkaConsumer.groupMetadata() instead. This class will be an interface in Kafka 5.0.
org.apache.kafka.common.ConsumerGroupState	Since 4.0. Use GroupState instead.
org.apache.kafka.common.Endpoint.listenerName()	Since 4.1. Use Endpoint.listener() instead. This function will be removed in 5.0.
org.apache.kafka.common.utils.Bytes.ByteArrayComparator	This interface is not part of the public API and will be removed in version 5.0. Internal Kafka code should use BytesUtils.ByteArrayComparator instead.
org.apache.kafka.common.utils.Bytes.BYTES_LEXICO_COMPARATOR	This field is not part of the public API and will be removed in version 5.0. Internal Kafka code should use BytesUtils.BYTES_LEXICO_COMPARATOR instead.
org.apache.kafka.common.utils.Bytes.increment(Bytes)	This method is not part of the public API and will be removed in version 5.0. Internal Kafka code should use BytesUtils.increment(Bytes) instead.
org.apache.kafka.server.telemetry.ClientTelemetry	Since 4.2.0, use ClientTelemetryExporterProvider instead. This interface will be removed in Kafka 5.0.0. The new interface provides a ClientTelemetryExporter which includes additional context such as the push interval.
org.apache.kafka.server.telemetry.ClientTelemetryReceiver	Since 4.2.0, use ClientTelemetryExporter instead. This interface will be removed in Kafka 5.0.0. The new interface provides additional context including the push interval to enable better metric lifecycle management.

Deprecated Interfaces

Interface	Description
org.apache.kafka.common.utils.Bytes.ByteArrayComparator	This interface is not part of the public API and will be removed in version 5.0. Internal Kafka code should use BytesUtils.ByteArrayComparator instead.
org.apache.kafka.server.telemetry.ClientTelemetry	Since 4.2.0, use ClientTelemetryExporterProvider instead. This interface will be removed in Kafka 5.0.0. The new interface provides a ClientTelemetryExporter which includes additional context such as the push interval.
org.apache.kafka.server.telemetry.ClientTelemetryReceiver	Since 4.2.0, use ClientTelemetryExporter instead. This interface will be removed in Kafka 5.0.0. The new interface provides additional context including the push interval to enable better metric lifecycle management.

Deprecated Classes

Class	Description
org.apache.kafka.clients.admin.ClientMetricsResourceListing
org.apache.kafka.clients.admin.ConsumerGroupListing	Since 4.1. Use Admin.listGroups(ListGroupsOptions) and GroupListing instead.
org.apache.kafka.clients.admin.ListClientMetricsResourcesOptions	Since 4.1. Use ListConfigResourcesOptions instead.
org.apache.kafka.clients.admin.ListClientMetricsResourcesResult	Since 4.1. Use ListConfigResourcesResult instead.
org.apache.kafka.clients.admin.ListConsumerGroupsOptions	Since 4.1. Use Admin.listGroups(ListGroupsOptions) instead.
org.apache.kafka.clients.admin.ListConsumerGroupsResult	Since 4.1. Use Admin.listGroups(ListGroupsOptions) instead.

Deprecated Enum Classes

Enum Class	Description
org.apache.kafka.clients.consumer.OffsetResetStrategy	since 4.0; will be removed in a future release. Not required by Kafka client users; no replacement is provided.
org.apache.kafka.common.ConsumerGroupState	Since 4.0. Use GroupState instead.

Deprecated Fields

Field	Description
org.apache.kafka.clients.producer.ProducerConfig.PARTITIONER_ADPATIVE_PARTITIONING_ENABLE_CONFIG
org.apache.kafka.common.config.TopicConfig.MESSAGE_DOWNCONVERSION_ENABLE_CONFIG	down-conversion is not possible in Apache Kafka 4.0 and newer, hence this configuration is a no-op, and it is deprecated for removal in Apache Kafka 5.0.
org.apache.kafka.common.config.TopicConfig.MESSAGE_DOWNCONVERSION_ENABLE_DOC	see TopicConfig.MESSAGE_DOWNCONVERSION_ENABLE_CONFIG.
org.apache.kafka.common.utils.Bytes.BYTES_LEXICO_COMPARATOR	This field is not part of the public API and will be removed in version 5.0. Internal Kafka code should use BytesUtils.BYTES_LEXICO_COMPARATOR instead.

Deprecated Methods

Method	Description
org.apache.kafka.clients.admin.Admin.listClientMetricsResources()	Since 4.1. Use Admin.listConfigResources() instead.
org.apache.kafka.clients.admin.Admin.listClientMetricsResources(ListClientMetricsResourcesOptions)	Since 4.1. Use Admin.listConfigResources(Set, ListConfigResourcesOptions) instead.
org.apache.kafka.clients.admin.Admin.listConsumerGroups()	Since 4.1. Use Admin.listGroups(ListGroupsOptions) instead.
org.apache.kafka.clients.admin.Admin.listConsumerGroups(ListConsumerGroupsOptions)	Since 4.1. Use Admin.listGroups(ListGroupsOptions) instead.
org.apache.kafka.clients.admin.ConsumerGroupDescription.state()	Since 4.0. Use ConsumerGroupDescription.groupState() instead.
org.apache.kafka.clients.admin.ConsumerGroupListing.state()	Since 4.0. Use ConsumerGroupListing.groupState() instead.
org.apache.kafka.clients.admin.CreateDelegationTokenOptions.maxlifeTimeMs()	Since 4.0 and should not be used any longer.
org.apache.kafka.clients.admin.CreateDelegationTokenOptions.maxlifeTimeMs(long)	Since 4.0 and should not be used any longer.
org.apache.kafka.clients.admin.ForwardingAdmin.listConsumerGroups(ListConsumerGroupsOptions)
org.apache.kafka.clients.admin.KafkaAdminClient.listConsumerGroups(ListConsumerGroupsOptions)
org.apache.kafka.clients.admin.ListConsumerGroupsOptions.inStates(Set<ConsumerGroupState>)	Since 4.0. Use ListConsumerGroupsOptions.inGroupStates(Set) instead.
org.apache.kafka.clients.admin.ListConsumerGroupsOptions.states()	Since 4.0. Use ListConsumerGroupsOptions.inGroupStates(Set) instead.
org.apache.kafka.clients.admin.RaftVoterEndpoint.name()	Since 4.1. Use RaftVoterEndpoint.listener() instead. This function will be removed in 5.0.
org.apache.kafka.clients.consumer.Consumer.close(Duration)
org.apache.kafka.clients.consumer.KafkaConsumer.close(Duration)
org.apache.kafka.clients.consumer.MockConsumer.close(Duration)
org.apache.kafka.common.Endpoint.listenerName()	Since 4.1. Use Endpoint.listener() instead. This function will be removed in 5.0.
org.apache.kafka.common.utils.Bytes.increment(Bytes)	This method is not part of the public API and will be removed in version 5.0. Internal Kafka code should use BytesUtils.increment(Bytes) instead.

Deprecated Constructors

Constructor	Description
org.apache.kafka.clients.admin.ConsumerGroupDescription(String, boolean, Collection<MemberDescription>, String, ConsumerGroupState, Node)	Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.
org.apache.kafka.clients.admin.ConsumerGroupDescription(String, boolean, Collection<MemberDescription>, String, ConsumerGroupState, Node, Set<AclOperation>)	Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.
org.apache.kafka.clients.admin.ConsumerGroupDescription(String, boolean, Collection<MemberDescription>, String, GroupType, ConsumerGroupState, Node, Set<AclOperation>)	Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.
org.apache.kafka.clients.admin.ConsumerGroupListing(String, boolean, Optional<ConsumerGroupState>)	Since 4.0. Use ConsumerGroupListing(String, Optional, boolean) instead.
org.apache.kafka.clients.admin.ConsumerGroupListing(String, boolean, Optional<ConsumerGroupState>, Optional<GroupType>)	Since 4.0. Use ConsumerGroupListing(String, Optional, Optional, boolean) instead.
org.apache.kafka.clients.admin.MemberDescription(String, String, String, MemberAssignment)	Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.
org.apache.kafka.clients.admin.MemberDescription(String, Optional<String>, String, String, MemberAssignment)	Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.
org.apache.kafka.clients.admin.MemberDescription(String, Optional<String>, String, String, MemberAssignment, Optional<MemberAssignment>)	Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.
org.apache.kafka.clients.admin.MemberDescription(String, Optional<String>, String, String, MemberAssignment, Optional<MemberAssignment>, Optional<Integer>, Optional<Boolean>)	Since 4.2. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.
org.apache.kafka.clients.consumer.ConsumerGroupMetadata(String)	Since 4.2, please use KafkaConsumer.groupMetadata() instead. This class will be an interface in Kafka 5.0.
org.apache.kafka.clients.consumer.ConsumerGroupMetadata(String, int, String, Optional<String>)	Since 4.2, please use KafkaConsumer.groupMetadata() instead. This class will be an interface in Kafka 5.0.
org.apache.kafka.clients.consumer.ConsumerRecords(Map<TopicPartition, List<ConsumerRecord<K, V>>>)	Since 4.0. Use ConsumerRecords(Map, Map) instead.
org.apache.kafka.clients.consumer.MockConsumer(OffsetResetStrategy)	Since 4.0. Use MockConsumer(String) instead.
org.apache.kafka.common.errors.RecordDeserializationException(TopicPartition, long, String, Throwable)	Since 3.9. Use RecordDeserializationException(DeserializationExceptionOrigin, TopicPartition, long, long, TimestampType, ByteBuffer, ByteBuffer, Headers, String, Throwable) instead.