Package org.apache.pulsar.client.api.v5

package org.apache.pulsar.client.api.v5

Pulsar Client API v5.

This is a redesigned client API that provides a cleaner, more modern interface for interacting with Apache Pulsar. Key design principles:

• No partition concept -- topics are opaque; only per-key ordering is guaranteed when a key is specified.
• Streaming vs queuing split -- StreamConsumer provides ordered consumption with cumulative acknowledgment, while QueueConsumer provides parallel unordered consumption with individual acknowledgment.
• Managed subscriptions -- consumers use broker-managed position tracking with automatic redelivery and dead-letter support.
• Checkpoint consumer -- CheckpointConsumer provides unmanaged consumption with consistent Checkpoint support, designed for connector frameworks (Flink, Spark).
• Modern Java -- uses Duration, Optional, Instant, records, and method-reference-friendly naming.
• Transactions are first-class citizens, integrated directly into the producer and consumer APIs.

Entry point: PulsarClient.builder().

Related Packages

Package	Description
org.apache.pulsar.client.api.v5.async	Asynchronous views of producers, consumers, and transactions.
org.apache.pulsar.client.api.v5.auth	Authentication and encryption types.
org.apache.pulsar.client.api.v5.config	Configuration value types and policy records.
org.apache.pulsar.client.api.v5.internal	Pulsar Client API v5.
org.apache.pulsar.client.api.v5.schema	Schema definitions for message serialization and deserialization.

Class	Description
Checkpoint	An opaque, serializable position vector representing a consistent point across all internal hash-range segments of a topic.
CheckpointConsumer<T>	An unmanaged consumer designed for connector frameworks (Flink, Spark, etc.).
CheckpointConsumerBuilder<T>	Builder for configuring and creating a CheckpointConsumer.
Message<T>	An immutable message received from a Pulsar topic.
MessageBuilder<T>	Synchronous message builder, obtained from Producer.newMessage().
MessageId	Opaque, immutable identifier for a message within a topic.
MessageMetadata<T,BuilderT extends MessageMetadata<T,BuilderT>>	Common message metadata that can be set on any outgoing message.
Messages<T>	A batch of messages received from a consumer.
Producer<T>	A producer publishes messages to a Pulsar topic.
ProducerBuilder<T>	Builder for configuring and creating a Producer.
PulsarClient	Entry point for the Pulsar client.
PulsarClientBuilder	Builder for configuring and creating a PulsarClient.
PulsarClientException	Base exception for all Pulsar client operations.
PulsarClientException.AlreadyClosedException
PulsarClientException.AuthenticationException
PulsarClientException.AuthorizationException
PulsarClientException.ConnectException
PulsarClientException.ConsumerBusyException
PulsarClientException.CryptoException
PulsarClientException.IncompatibleSchemaException
PulsarClientException.InvalidConfigurationException
PulsarClientException.InvalidServiceURLException
PulsarClientException.MemoryBufferIsFullException
PulsarClientException.NotConnectedException
PulsarClientException.NotFoundException
PulsarClientException.ProducerBusyException
PulsarClientException.ProducerQueueIsFullException
PulsarClientException.TimeoutException
PulsarClientException.TopicTerminatedException
PulsarClientException.TransactionConflictException
QueueConsumer<T>	A consumer for queue (unordered) consumption with broker-managed position tracking.
QueueConsumerBuilder<T>	Builder for configuring and creating a QueueConsumer.
StreamConsumer<T>	A consumer for streaming (ordered) consumption with broker-managed position tracking.
StreamConsumerBuilder<T>	Builder for configuring and creating a StreamConsumer.
Transaction	A Pulsar transaction handle.
Transaction.State