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

Interface PulsarClient

All Superinterfaces:

AutoCloseable

public interface PulsarClient
extends AutoCloseable

Entry point for the Pulsar client. Provides factory methods for creating producers, consumers, and transactions.

Instances are created via builder().

A PulsarClient manages internal resources such as connections, threads, and memory buffers. It must be closed when no longer needed.

Method Summary

Modifier and Type	Method	Description
static PulsarClientBuilder	builder()	Create a new client builder.
void	close()	Close the client and release all resources, waiting for pending operations to complete.
CompletableFuture<Void>	closeAsync()	Asynchronous counterpart of close().
<T> CheckpointConsumerBuilder<T>	newCheckpointConsumer(Schema<T> schema)	Create a checkpoint consumer builder with a specific schema.
<T> ProducerBuilder<T>	newProducer(Schema<T> schema)	Create a producer builder with a specific schema.
<T> QueueConsumerBuilder<T>	newQueueConsumer(Schema<T> schema)	Create a queue consumer builder with a specific schema.
<T> StreamConsumerBuilder<T>	newStreamConsumer(Schema<T> schema)	Create a stream consumer builder with a specific schema.
Transaction	newTransaction()	Create a new transaction, blocking until it is ready.
CompletableFuture<Transaction>	newTransactionAsync()	Asynchronous counterpart of newTransaction().
void	shutdown()	Shutdown the client instance.

Method Details

builder

static PulsarClientBuilder builder()

Create a new client builder.

Returns:

a new PulsarClientBuilder for configuring the client

newProducer

<T> ProducerBuilder<T> newProducer(Schema<T> schema)

Create a producer builder with a specific schema.

Type Parameters:

T - the message value type

Parameters:

schema - the schema used for serialization/deserialization

Returns:

a new ProducerBuilder for configuring the producer

newStreamConsumer

<T> StreamConsumerBuilder<T> newStreamConsumer(Schema<T> schema)

Create a stream consumer builder with a specific schema.

Type Parameters:

T - the message value type

Parameters:

schema - the schema used for serialization/deserialization

Returns:

a new StreamConsumerBuilder for configuring the stream consumer

newQueueConsumer

<T> QueueConsumerBuilder<T> newQueueConsumer(Schema<T> schema)

Create a queue consumer builder with a specific schema.

Type Parameters:

T - the message value type

Parameters:

schema - the schema used for serialization/deserialization

Returns:

a new QueueConsumerBuilder for configuring the queue consumer

newCheckpointConsumer

<T> CheckpointConsumerBuilder<T> newCheckpointConsumer(Schema<T> schema)

Create a checkpoint consumer builder with a specific schema.

Checkpoint consumers are unmanaged — position tracking is external. Designed for connector frameworks (Flink, Spark) that manage their own state.

Type Parameters:

T - the message value type

Parameters:

schema - the schema used for serialization/deserialization

Returns:

a new CheckpointConsumerBuilder for configuring the checkpoint consumer

newTransaction

Transaction newTransaction()
                    throws PulsarClientException

Create a new transaction, blocking until it is ready. The transaction timeout is taken from the client-wide TransactionPolicy configured on PulsarClientBuilder.transactionPolicy(org.apache.pulsar.client.api.v5.config.TransactionPolicy).

Returns:

a new Transaction in the Transaction.State.OPEN state

Throws:

PulsarClientException - if the transaction cannot be created (e.g., transaction coordinator unavailable or the client is closed)

newTransactionAsync

CompletableFuture<Transaction> newTransactionAsync()

Asynchronous counterpart of newTransaction().

Returns:

a CompletableFuture that completes with a new Transaction in the Transaction.State.OPEN state, or completes exceptionally with PulsarClientException on failure

close

void close()
    throws PulsarClientException

Close the client and release all resources, waiting for pending operations to complete.

Specified by:

close in interface AutoCloseable

Throws:

PulsarClientException - if an error occurs while closing the client

closeAsync

CompletableFuture<Void> closeAsync()

Asynchronous counterpart of close().

Returns:

a CompletableFuture that completes when the client has finished closing, or completes exceptionally with PulsarClientException on failure

shutdown

void shutdown()

Shutdown the client instance.

Release all resources used by the client, without waiting for pending operations to complete.