Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abort() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncTransaction
-
Abort this transaction, discarding all produced messages and rolling back acknowledgments.
- abort() - Method in interface org.apache.pulsar.client.api.v5.Transaction
-
Abort this transaction, discarding all produced messages and rolling back acknowledgments.
- ABORTED - Enum constant in enum class org.apache.pulsar.client.api.v5.Transaction.State
- ABORTING - Enum constant in enum class org.apache.pulsar.client.api.v5.Transaction.State
- accessMode(ProducerAccessMode) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Access mode for this producer on the topic.
- acknowledge(Message) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncQueueConsumer
-
Acknowledge a single message.
- acknowledge(MessageId) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncQueueConsumer
-
Acknowledge a single message by its ID.
- acknowledge(MessageId) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
Acknowledge a single message by its ID.
- acknowledge(MessageId, Transaction) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncQueueConsumer
-
Acknowledge within a transaction.
- acknowledge(MessageId, Transaction) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
Acknowledge within a transaction.
- acknowledgeCumulative(MessageId) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncStreamConsumer
-
Acknowledge all messages up to and including the given message ID.
- acknowledgeCumulative(MessageId) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
Acknowledge all messages up to and including the given message ID.
- acknowledgeCumulative(MessageId, Transaction) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncStreamConsumer
-
Acknowledge within a transaction.
- acknowledgeCumulative(MessageId, Transaction) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
Acknowledge within a transaction.
- acknowledgmentGroupTime(Duration) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
How frequently acknowledgments are flushed to the broker.
- acknowledgmentGroupTime(Duration) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
How frequently cumulative acknowledgments are flushed to the broker.
- AlreadyClosedException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.AlreadyClosedException
- asMap() - Method in class org.apache.pulsar.client.api.v5.auth.HttpAuthHeaders
- async() - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumer
-
Return the asynchronous view of this consumer.
- async() - Method in interface org.apache.pulsar.client.api.v5.Producer
-
Return the asynchronous view of this producer.
- async() - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
Return the asynchronous view of this consumer.
- async() - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
Return the asynchronous view of this consumer.
- async() - Method in interface org.apache.pulsar.client.api.v5.Transaction
-
Return an asynchronous view of this transaction.
- AsyncCheckpointConsumer<T> - Interface in org.apache.pulsar.client.api.v5.async
-
Asynchronous view of a
CheckpointConsumer. - AsyncMessageBuilder<T> - Interface in org.apache.pulsar.client.api.v5.async
-
Asynchronous message builder, obtained from
AsyncProducer.newMessage(). - AsyncProducer<T> - Interface in org.apache.pulsar.client.api.v5.async
-
Asynchronous view of a
Producer. - AsyncQueueConsumer<T> - Interface in org.apache.pulsar.client.api.v5.async
-
Asynchronous view of a
QueueConsumer. - AsyncStreamConsumer<T> - Interface in org.apache.pulsar.client.api.v5.async
-
Asynchronous view of a
StreamConsumer. - AsyncTransaction - Interface in org.apache.pulsar.client.api.v5.async
-
Asynchronous view of a
Transaction. - AuthChallenge - Record Class in org.apache.pulsar.client.api.v5.auth
-
A binary-protocol
CommandAuthChallengepayload handed to aBinaryAuthChallengeHandler(PIP-478). - AuthChallenge(byte[]) - Constructor for record class org.apache.pulsar.client.api.v5.auth.AuthChallenge
-
Creates an instance of a
AuthChallengerecord class. - authentication(String, String) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Set authentication by plugin class name and parameter string.
- authentication(Authentication) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Set the authentication provider from an instance supplied programmatically.
- Authentication - Interface in org.apache.pulsar.client.api.v5.auth
-
Pluggable authentication provider for the Pulsar v5 client (PIP-478).
- AuthenticationCallContext - Interface in org.apache.pulsar.client.api.v5.auth
-
The per-call context for binary-protocol authentication (PIP-478).
- AuthenticationException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.AuthenticationException
- AuthenticationException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.AuthenticationException
- AuthenticationFactory - Class in org.apache.pulsar.client.api.v5.auth
-
Factory for creating common authentication providers.
- AuthenticationInitContext - Interface in org.apache.pulsar.client.api.v5.auth
-
Runtime services handed to
Authentication.initializeAsync(AuthenticationInitContext)once when the client is built (PIP-478). - authenticationTls() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- authenticationToken(String) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- authenticationToken(Supplier) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- authMethodName() - Method in interface org.apache.pulsar.client.api.v5.auth.BinaryAuthDataProvider
- AuthorizationException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.AuthorizationException
- AUTO_CONSUME - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- AUTO_PUBLISH - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- autoConsume() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema that auto-detects the topic schema at runtime and decodes each message into a
GenericRecord. - autoConsumeSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- autoProduceBytes() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema that auto-detects the topic schema and produces raw bytes accordingly.
- autoProduceBytesOf(Schema) - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema that produces raw bytes while validating them against the supplied
baseschema (in addition to the topic schema). - autoProduceBytesSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- autoProduceBytesSchema(Schema) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- avro(Class) - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get an Avro schema for a POJO class.
- AVRO - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- avroSchema(Class) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
B
- BackoffPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Backoff configuration for broker reconnection attempts.
- BackoffPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
BackoffPolicy. - batchingPolicy(BatchingPolicy) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Configure message batching.
- BatchingPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Configuration for producer message batching.
- BatchingPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
BatchingPolicy. - BinaryAuthChallengeHandler - Interface in org.apache.pulsar.client.api.v5.auth
-
Capability: multi-round challenge/response (SASL-style and custom protocols) for the Pulsar binary protocol (PIP-478).
- BinaryAuthData - Record Class in org.apache.pulsar.client.api.v5.auth
-
The binary-protocol credential: the
auth_databytes forCommandConnect(PIP-478). - BinaryAuthData(byte[]) - Constructor for record class org.apache.pulsar.client.api.v5.auth.BinaryAuthData
-
Creates an instance of a
BinaryAuthDatarecord class. - BinaryAuthDataProvider - Interface in org.apache.pulsar.client.api.v5.auth
-
Capability: single-pass credential exchange for the Pulsar binary protocol (PIP-478).
- bindClientAuthenticationServices(ClientAuthenticationServices) - Method in interface org.apache.pulsar.client.api.v5.internal.ClientAuthenticationServicesAware
-
Bind the framework's client services into this driver.
- blockIfQueueFull(boolean) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
What a send does when the client memory limit is reached.
- blockingExecutor() - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationInitContext
-
Dedicated executor for off-loading potentially-blocking authentication work, kept separate from
AuthenticationInitContext.scheduler()so that blocking calls cannot starve the scheduler's threads or delay scheduled tasks. - blockingExecutor() - Method in interface org.apache.pulsar.client.api.v5.internal.ClientAuthenticationServices
- bool() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for boolean values.
- BOOLEAN - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- booleanSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- brokerHost() - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationCallContext
- build() - Method in class org.apache.pulsar.client.api.v5.auth.PemFileKeyProvider.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.ChunkingPolicy.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.CompressionPolicy.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Build the
ConnectionPolicy. - build() - Method in class org.apache.pulsar.client.api.v5.config.ConsumerEncryptionPolicy.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.ProcessingTimeoutPolicy.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy.Builder
- build() - Method in class org.apache.pulsar.client.api.v5.config.TransactionPolicy.Builder
- build() - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Build and return the configured client.
- builder() - Static method in class org.apache.pulsar.client.api.v5.auth.PemFileKeyProvider
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.ChunkingPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.CompressionPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.ConsumerEncryptionPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.ProcessingTimeoutPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy
- builder() - Static method in class org.apache.pulsar.client.api.v5.config.TransactionPolicy
- builder() - Static method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Create a new client builder.
- bytes() - Method in record class org.apache.pulsar.client.api.v5.auth.AuthChallenge
-
Returns the value of the
bytesrecord component. - bytes() - Method in record class org.apache.pulsar.client.api.v5.auth.BinaryAuthData
-
Returns the value of the
bytesrecord component. - bytes() - Method in record class org.apache.pulsar.client.api.v5.auth.ChallengeResponse
-
Returns the value of the
bytesrecord component. - bytes() - Method in record class org.apache.pulsar.client.api.v5.config.MemorySize
-
Returns the value of the
bytesrecord component. - bytes() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for raw byte arrays (no serialization).
- BYTES - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- byteSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- bytesSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
C
- callbackThreads() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- callbackThreads(int) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Number of threads for message listener callbacks.
- capability(Class) - Method in interface org.apache.pulsar.client.api.v5.auth.Authentication
-
Capability factory — the framework's ONLY discovery mechanism.
- ChallengeResponse - Record Class in org.apache.pulsar.client.api.v5.auth
-
The reply from
BinaryAuthChallengeHandler.respondToChallengeAsync(AuthenticationCallContext, AuthChallenge)— the bytes for the nextCommandAuthResponse(PIP-478). - ChallengeResponse(byte[]) - Constructor for record class org.apache.pulsar.client.api.v5.auth.ChallengeResponse
-
Creates an instance of a
ChallengeResponserecord class. - checkpoint() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncCheckpointConsumer
-
Create a consistent checkpoint asynchronously.
- checkpoint() - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumer
-
Create a consistent checkpoint — an atomic snapshot of positions across all internal hash-range segments.
- Checkpoint - Interface in org.apache.pulsar.client.api.v5
-
An opaque, serializable position vector representing a consistent point across all internal hash-range segments of a topic.
- CheckpointConsumer<T> - Interface in org.apache.pulsar.client.api.v5
-
An unmanaged consumer designed for connector frameworks (Flink, Spark, etc.).
- CheckpointConsumerBuilder<T> - Interface in org.apache.pulsar.client.api.v5
-
Builder for configuring and creating a
CheckpointConsumer. - checkpointFromBytes(byte[]) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- chunkingPolicy(ChunkingPolicy) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Enable chunking for large messages that exceed the broker's max message size.
- ChunkingPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Configuration for chunking large messages that exceed the broker's max message size.
- ChunkingPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
ChunkingPolicy. - chunkSize() - Method in class org.apache.pulsar.client.api.v5.config.ChunkingPolicy
- chunkSize(int) - Method in class org.apache.pulsar.client.api.v5.config.ChunkingPolicy.Builder
-
Maximum size of each chunk in bytes.
- ClientAuthenticationServices - Interface in org.apache.pulsar.client.api.v5.internal
-
The framework-owned runtime services a
PulsarClientlate-binds into its authentication driver once the client instance exists (PIP-478). - ClientAuthenticationServicesAware - Interface in org.apache.pulsar.client.api.v5.internal
-
Implemented by an authentication driver that wants the framework's real client services late-bound into it after the
PulsarClientis constructed (PIP-478). - clientInstanceId() - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationInitContext
- clientInstanceId() - Method in interface org.apache.pulsar.client.api.v5.internal.ClientAuthenticationServices
- clock() - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationInitContext
- clock() - Method in interface org.apache.pulsar.client.api.v5.internal.ClientAuthenticationServices
- close() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncCheckpointConsumer
-
Close this consumer asynchronously.
- close() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncProducer
-
Close this producer asynchronously.
- close() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncQueueConsumer
-
Close this consumer asynchronously.
- close() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncStreamConsumer
-
Close this consumer asynchronously.
- close() - Method in interface org.apache.pulsar.client.api.v5.auth.Authentication
- close() - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumer
-
Close the consumer and release all resources.
- close() - Method in interface org.apache.pulsar.client.api.v5.Producer
-
Close this producer and release all associated resources.
- close() - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Close the client and release all resources, waiting for pending operations to complete.
- close() - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
Close the consumer and release all resources.
- close() - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
Close the consumer and release all resources.
- closeAsync() - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Asynchronous counterpart of
PulsarClient.close(). - commit() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncTransaction
-
Commit this transaction, making all produced messages visible and all acknowledgments durable.
- commit() - Method in interface org.apache.pulsar.client.api.v5.Transaction
-
Commit this transaction, making all produced messages visible and all acknowledgments durable.
- COMMITTED - Enum constant in enum class org.apache.pulsar.client.api.v5.Transaction.State
- COMMITTING - Enum constant in enum class org.apache.pulsar.client.api.v5.Transaction.State
- compressionPolicy(CompressionPolicy) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Configure compression for message payloads.
- CompressionPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Compression configuration for producer message payloads.
- CompressionPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
CompressionPolicy. - CompressionType - Enum Class in org.apache.pulsar.client.api.v5.config
-
Compression codec used for message payloads.
- configure(Map) - Method in interface org.apache.pulsar.client.api.v5.auth.Authentication
-
Configuration step.
- ConnectException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.ConnectException
- ConnectException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.ConnectException
- connectionBackoff() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- connectionBackoff(BackoffPolicy) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Backoff strategy for broker reconnection attempts.
- connectionMaxIdleTime() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- connectionMaxIdleTime(Duration) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Maximum idle time before a connection is closed.
- connectionPolicy(ConnectionPolicy) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Configure connection-level settings such as timeouts, pool size, threading, keep-alive, and proxy configuration.
- ConnectionPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Connection-level settings for the Pulsar client.
- ConnectionPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
ConnectionPolicy. - connectionsPerBroker() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- connectionsPerBroker(int) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Maximum number of TCP connections per broker.
- connectionTimeout() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- connectionTimeout(Duration) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Timeout for establishing a TCP connection to the broker.
- CONSUME - Enum constant in enum class org.apache.pulsar.client.api.v5.auth.ConsumerCryptoFailureAction
-
Deliver the message to the application as-is, with the still-encrypted payload.
- ConsumerBusyException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.ConsumerBusyException
- ConsumerCryptoFailureAction - Enum Class in org.apache.pulsar.client.api.v5.auth
-
Action a consumer takes when message decryption fails (e.g.
- ConsumerEncryptionPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Consumer-side end-to-end decryption configuration.
- ConsumerEncryptionPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
ConsumerEncryptionPolicy. - consumerGroup(String) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
Join a named consumer group on this scalable topic.
- consumerName() - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
The consumer name (system-assigned or user-specified).
- consumerName() - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
The consumer name (system-assigned or user-specified).
- consumerName(String) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
A custom name for this consumer instance.
- consumerName(String) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
A custom name for this consumer instance.
- consumerName(String) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
A custom name for this consumer instance.
- count() - Method in interface org.apache.pulsar.client.api.v5.Messages
-
The number of messages in this batch.
- create() - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
Create the checkpoint consumer, blocking until it is ready.
- create() - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Create the producer, blocking until it is ready.
- create(String, String) - Static method in class org.apache.pulsar.client.api.v5.auth.AuthenticationFactory
-
Create an authentication provider by plugin class name and parameter string.
- create(String, Map) - Static method in class org.apache.pulsar.client.api.v5.auth.AuthenticationFactory
-
Create an authentication provider by plugin class name and parameter map.
- createAsync() - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
Create the checkpoint consumer asynchronously.
- createAsync() - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Create the producer asynchronously.
- createAuthentication(String, String) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- createAuthentication(String, Map) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- CryptoException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.CryptoException
- CryptoKeyProvider - Interface in org.apache.pulsar.client.api.v5.auth
-
Convenience interface for implementations that serve both public keys (for producer-side encryption) and private keys (for consumer-side decryption) — for example, a single PEM-file-backed key store used by both sides of an in-process round trip.
D
- data() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The raw bytes of the message payload.
- deadLetterPolicy(DeadLetterPolicy) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Configure the dead letter queue policy.
- DeadLetterPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Configuration for the dead letter queue mechanism.
- DeadLetterPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
DeadLetterPolicy. - deadLetterTopic() - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy
- deadLetterTopic(String) - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy.Builder
-
Custom dead letter topic.
- decode(byte[]) - Method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Decode bytes to a value.
- decode(byte[], byte[]) - Method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Decode bytes with a specific schema version.
- decode(ByteBuffer) - Method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Decode from a ByteBuffer.
- DEFAULT_JITTER_PERCENT - Static variable in class org.apache.pulsar.client.api.v5.config.BackoffPolicy
-
Default jitter percentage applied when not explicitly specified.
- deliverAfter(Duration) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Request delayed delivery: the message becomes visible to consumers after the given delay.
- deliverAt(Instant) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Request delayed delivery: the message becomes visible to consumers at the given time.
- description(String) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
A human-readable description of this client (for logging and debugging).
- disabled() - Static method in class org.apache.pulsar.client.api.v5.config.CompressionPolicy
-
No compression.
- DISCARD - Enum constant in enum class org.apache.pulsar.client.api.v5.auth.ConsumerCryptoFailureAction
-
Silently acknowledge and skip the message.
- DOUBLE - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- doubleSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
E
- earliest() - Static method in interface org.apache.pulsar.client.api.v5.Checkpoint
-
A sentinel checkpoint representing the beginning of the topic (oldest available data).
- earliest() - Static method in interface org.apache.pulsar.client.api.v5.MessageId
-
Sentinel representing the oldest available message in the topic.
- EARLIEST - Enum constant in enum class org.apache.pulsar.client.api.v5.config.SubscriptionInitialPosition
-
Start consuming from the earliest available message in the topic.
- earliestCheckpoint() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- earliestMessageId() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- empty() - Static method in class org.apache.pulsar.client.api.v5.auth.HttpAuthHeaders
- enabled() - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy
- enabled() - Method in class org.apache.pulsar.client.api.v5.config.ChunkingPolicy
- enabled(boolean) - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy.Builder
-
Whether batching is enabled.
- enabled(boolean) - Method in class org.apache.pulsar.client.api.v5.config.ChunkingPolicy.Builder
-
Whether chunking is enabled.
- enableTcpNoDelay() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- enableTcpNoDelay(boolean) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Enable TCP no-delay (disable Nagle's algorithm).
- encode(T) - Method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Encode a value to bytes.
- EncryptionKey - Class in org.apache.pulsar.client.api.v5.auth
-
A single encryption / decryption key returned by a
PublicKeyProviderorPrivateKeyProvider. - encryptionPolicy(ConsumerEncryptionPolicy) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
Configure end-to-end message encryption for decryption.
- encryptionPolicy(ConsumerEncryptionPolicy) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Configure end-to-end message encryption for decryption.
- encryptionPolicy(ConsumerEncryptionPolicy) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Configure end-to-end message encryption for decryption.
- encryptionPolicy(ProducerEncryptionPolicy) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Configure end-to-end message encryption.
- equals(Object) - Method in record class org.apache.pulsar.client.api.v5.auth.AuthChallenge
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.apache.pulsar.client.api.v5.auth.BinaryAuthData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.apache.pulsar.client.api.v5.auth.ChallengeResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.apache.pulsar.client.api.v5.config.MemorySize
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.apache.pulsar.client.api.v5.schema.Field
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.apache.pulsar.client.api.v5.schema.KeyValue
-
Indicates whether some other object is "equal to" this one.
- ERROR - Enum constant in enum class org.apache.pulsar.client.api.v5.Transaction.State
- eventTime() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The event time set by the producer, if any.
- eventTime(Instant) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Set the event time of the message.
- EXCLUSIVE - Enum constant in enum class org.apache.pulsar.client.api.v5.config.ProducerAccessMode
-
Only one producer is allowed on the topic.
- EXCLUSIVE_WITH_FENCING - Enum constant in enum class org.apache.pulsar.client.api.v5.config.ProducerAccessMode
-
Only one producer is allowed on the topic.
- exponential(Duration, Duration) - Static method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy
-
Create an exponential backoff with the given bounds, a default multiplier of 2 and the default jitter.
F
- FAIL - Enum constant in enum class org.apache.pulsar.client.api.v5.auth.ConsumerCryptoFailureAction
-
Fail the
receivecall. - FAIL - Enum constant in enum class org.apache.pulsar.client.api.v5.auth.ProducerCryptoFailureAction
-
Fail the
sendcall. - failureAction() - Method in class org.apache.pulsar.client.api.v5.config.ConsumerEncryptionPolicy
- failureAction() - Method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy
- failureAction(ConsumerCryptoFailureAction) - Method in class org.apache.pulsar.client.api.v5.config.ConsumerEncryptionPolicy.Builder
-
Action to take when decryption fails.
- failureAction(ProducerCryptoFailureAction) - Method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy.Builder
-
Action to take when encryption fails.
- field(String) - Method in interface org.apache.pulsar.client.api.v5.schema.GenericRecord
-
Get the value of a field by name.
- field(Field) - Method in interface org.apache.pulsar.client.api.v5.schema.GenericRecord
-
Get the value of a field.
- Field - Record Class in org.apache.pulsar.client.api.v5.schema
-
A named field of a
GenericRecord. - Field(String, int) - Constructor for record class org.apache.pulsar.client.api.v5.schema.Field
-
Creates an instance of a
Fieldrecord class. - fields() - Method in interface org.apache.pulsar.client.api.v5.schema.GenericRecord
-
The fields of this record, in declaration order.
- fixed(Duration, Duration) - Static method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy
-
Create a fixed backoff (no increase between retries) with the default jitter.
- FLOAT - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- float32() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for 32-bit floating point numbers.
- float64() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for 64-bit floating point numbers.
- floatSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- flush() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncProducer
-
Flush all pending messages asynchronously.
- fromByteArray(byte[]) - Static method in interface org.apache.pulsar.client.api.v5.Checkpoint
-
Deserialize a checkpoint from a byte array previously obtained via
Checkpoint.toByteArray(). - fromByteArray(byte[]) - Static method in interface org.apache.pulsar.client.api.v5.MessageId
-
Deserialize a message ID from bytes previously produced by
MessageId.toByteArray().
G
- generic(SchemaInfo) - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Build a generic schema from a raw
SchemaInfodefinition. - GenericRecord - Interface in org.apache.pulsar.client.api.v5.schema
-
A schema-less view over a decoded message value, used when the value's schema is discovered at runtime rather than known at compile time (see
Schema.autoConsume()). - genericSchema(SchemaInfo) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- get() - Static method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- get(String) - Method in class org.apache.pulsar.client.api.v5.auth.HttpAuthHeaders
-
Look up a header value, case-insensitively.
- getAuthDataAsync(AuthenticationCallContext) - Method in interface org.apache.pulsar.client.api.v5.auth.BinaryAuthDataProvider
-
Produce a credential for the binary-protocol connection.
- getHttpHeadersAsync(HttpAuthCallContext) - Method in interface org.apache.pulsar.client.api.v5.auth.HttpAuthHeadersProvider
-
Produce the authentication headers for an outgoing HTTP request (for example
Authorization: Bearer <jwt>, or a custom header such asAthenz-Role-Auth). - getPrivateKey(String, Map) - Method in class org.apache.pulsar.client.api.v5.auth.PemFileKeyProvider
- getPrivateKey(String, Map) - Method in interface org.apache.pulsar.client.api.v5.auth.PrivateKeyProvider
-
Look up the private key for the given name.
- getPublicKey(String) - Method in class org.apache.pulsar.client.api.v5.auth.PemFileKeyProvider
- getPublicKey(String) - Method in interface org.apache.pulsar.client.api.v5.auth.PublicKeyProvider
-
Look up the public key with the given name.
- getStateObject(Class) - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationCallContext
-
Retrieve an implementation-controlled state object previously stored with
AuthenticationCallContext.setStateObject(Class, T). - getStateObject(Class) - Method in interface org.apache.pulsar.client.api.v5.auth.HttpAuthCallContext
-
Retrieve an implementation-controlled state object previously stored with
HttpAuthCallContext.setStateObject(Class, T). - GettingAuthenticationDataException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.GettingAuthenticationDataException
- GettingAuthenticationDataException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.GettingAuthenticationDataException
H
- hashCode() - Method in record class org.apache.pulsar.client.api.v5.auth.AuthChallenge
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.apache.pulsar.client.api.v5.auth.BinaryAuthData
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.apache.pulsar.client.api.v5.auth.ChallengeResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.apache.pulsar.client.api.v5.config.MemorySize
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.apache.pulsar.client.api.v5.schema.Field
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.apache.pulsar.client.api.v5.schema.KeyValue
-
Returns a hash code value for this object.
- HttpAuthCallContext - Interface in org.apache.pulsar.client.api.v5.auth
-
The per-call context for HTTP authentication (PIP-478).
- HttpAuthChallengeHandler - Interface in org.apache.pulsar.client.api.v5.auth
-
Capability: SASL-style multi-round challenge/response over HTTP (PIP-478).
- HttpAuthHeaders - Class in org.apache.pulsar.client.api.v5.auth
-
HTTP authentication headers an implementation produces for an outgoing request (and, for challenge/response, the headers carrying a server's challenge) (PIP-478).
- HttpAuthHeadersProvider - Interface in org.apache.pulsar.client.api.v5.auth
-
Capability: single-pass credential exchange for the Pulsar HTTP transport (PIP-478).
- httpClientFactory() - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationInitContext
-
Factory for
PulsarHttpClientinstances. - httpClientFactory() - Method in interface org.apache.pulsar.client.api.v5.internal.ClientAuthenticationServices
I
- id() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The unique identifier of this message within the topic.
- IncompatibleSchemaException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.IncompatibleSchemaException
- index() - Method in record class org.apache.pulsar.client.api.v5.schema.Field
-
Returns the value of the
indexrecord component. - initialInterval() - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy
- initialInterval(Duration) - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy.Builder
-
Delay before the first reconnection attempt.
- initializeAsync(AuthenticationInitContext) - Method in interface org.apache.pulsar.client.api.v5.auth.Authentication
-
Initialization step.
- initialSequenceId(long) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Set the initial sequence ID for producer message deduplication.
- initialSubscriptionName() - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy
- initialSubscriptionName(String) - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy.Builder
-
Subscription name to create on the dead letter topic, ensuring messages forwarded to the DLQ are retained until consumed.
- int16() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for 16-bit signed integers.
- INT16 - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- int32() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for 32-bit signed integers.
- INT32 - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- int64() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for 64-bit signed integers.
- INT64 - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- int8() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for 8-bit signed integers.
- INT8 - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- intSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- InvalidConfigurationException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.InvalidConfigurationException
- InvalidConfigurationException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.InvalidConfigurationException
- InvalidServiceURLException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.InvalidServiceURLException
- InvalidServiceURLException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.InvalidServiceURLException
- ioThreads() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- ioThreads(int) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Number of I/O threads for managing connections and reading data.
- isEmpty() - Method in class org.apache.pulsar.client.api.v5.auth.HttpAuthHeaders
J
- jitterPercent() - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy
- jitterPercent(double) - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy.Builder
-
Symmetric jitter percentage applied to each returned delay.
- json(Class) - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a JSON schema for a POJO class.
- JSON - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- jsonSchema(Class) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
K
- keepAliveInterval() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- keepAliveInterval(Duration) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Interval for sending keep-alive probes on idle connections.
- key() - Method in class org.apache.pulsar.client.api.v5.auth.EncryptionKey
- key() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The message key, used for per-key ordering.
- key() - Method in record class org.apache.pulsar.client.api.v5.schema.KeyValue
-
Returns the value of the
keyrecord component. - key(String) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Set the message key.
- KEY_VALUE - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- keyName(String) - Method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy.Builder
-
Single key name shortcut — equivalent to
keyNames(List.of(name)). - keyNames() - Method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy
- keyNames(String...) - Method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy.Builder
-
Multiple key names.
- KeyValue<K,
V> - Record Class in org.apache.pulsar.client.api.v5.schema -
A key/value pair, used as the native object of a
GenericRecordwhose schema type isSchemaType.KEY_VALUE. - KeyValue(K, V) - Constructor for record class org.apache.pulsar.client.api.v5.schema.KeyValue
-
Creates an instance of a
KeyValuerecord class.
L
- lastId() - Method in interface org.apache.pulsar.client.api.v5.Messages
-
The last message id in this batch.
- lastSequenceId() - Method in interface org.apache.pulsar.client.api.v5.Producer
-
The last sequence ID published by this producer.
- latest() - Static method in interface org.apache.pulsar.client.api.v5.Checkpoint
-
A sentinel checkpoint representing the end of the topic (next message to be published).
- latest() - Static method in interface org.apache.pulsar.client.api.v5.MessageId
-
Sentinel representing the next message to be published (i.e., the end of the topic).
- LATEST - Enum constant in enum class org.apache.pulsar.client.api.v5.config.SubscriptionInitialPosition
-
Start consuming from the latest message (the next message published after subscribing).
- latestCheckpoint() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- latestMessageId() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- listenerName(String) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Set the listener name for multi-listener brokers.
- longSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- LZ4 - Enum constant in enum class org.apache.pulsar.client.api.v5.config.CompressionType
-
LZ4 compression.
M
- maxAcknowledgmentGroupSize(int) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Maximum number of acknowledgments to group before flushing.
- maxInterval() - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy
- maxInterval(Duration) - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy.Builder
-
Upper bound on the backoff delay.
- maxMessages() - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy
- maxMessages(int) - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy.Builder
-
Maximum number of messages per batch.
- maxPublishDelay() - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy
- maxPublishDelay(Duration) - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy.Builder
-
Maximum time the producer waits before flushing a partial batch.
- maxRedeliverCount() - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy
- maxRedeliverCount(int) - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy.Builder
-
Maximum number of redelivery attempts before sending to the dead letter topic.
- maxSize() - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy
- maxSize(MemorySize) - Method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy.Builder
-
Maximum payload size per batch.
- MemoryBufferIsFullException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.MemoryBufferIsFullException
- memoryLimit(MemorySize) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Maximum amount of memory the client may hold in pending messages, across all of its producers and consumers.
- MemorySize - Record Class in org.apache.pulsar.client.api.v5.config
-
A type-safe representation of a memory size in bytes.
- MemorySize(long) - Constructor for record class org.apache.pulsar.client.api.v5.config.MemorySize
-
Creates an instance of a
MemorySizerecord class. - Message<T> - Interface in org.apache.pulsar.client.api.v5
-
An immutable message received from a Pulsar topic.
- MessageBuilder<T> - Interface in org.apache.pulsar.client.api.v5
-
Synchronous message builder, obtained from
Producer.newMessage(). - MessageId - Interface in org.apache.pulsar.client.api.v5
-
Opaque, immutable identifier for a message within a topic.
- messageIdFromBytes(byte[]) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- MessageMetadata<T,
BuilderT> - Interface in org.apache.pulsar.client.api.v5 -
Common message metadata that can be set on any outgoing message.
- Messages<T> - Interface in org.apache.pulsar.client.api.v5
-
A batch of messages received from a consumer.
- metadata() - Method in class org.apache.pulsar.client.api.v5.auth.EncryptionKey
- multiplier() - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy
- multiplier(double) - Method in class org.apache.pulsar.client.api.v5.config.BackoffPolicy.Builder
-
Multiplier applied to the previous delay on each retry.
N
- name() - Method in record class org.apache.pulsar.client.api.v5.schema.Field
-
Returns the value of the
namerecord component. - name() - Method in interface org.apache.pulsar.client.api.v5.schema.SchemaInfo
-
The name of the schema.
- namespace(String) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Subscribe to every scalable topic under a namespace.
- namespace(String) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Subscribe to every scalable topic under a namespace.
- namespace(String, Map) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Subscribe to scalable topics under a namespace whose properties match every key/value pair in
propertyFilters(AND semantics). - namespace(String, Map) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Subscribe to scalable topics under a namespace whose properties match every key/value pair in
propertyFilters(AND semantics). - nativeObject() - Method in interface org.apache.pulsar.client.api.v5.schema.GenericRecord
-
The underlying decoded value: a
KeyValueforSchemaType.KEY_VALUE, a primitive for a primitive schema, or an implementation-specific native record for structured types. - negativeAcknowledge(Message) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncQueueConsumer
-
Signal that this message could not be processed.
- negativeAcknowledge(MessageId) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncQueueConsumer
-
Signal that this message could not be processed.
- negativeAcknowledge(MessageId) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
Signal that the message with this ID could not be processed.
- negativeAckRedeliveryBackoff(BackoffPolicy) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Backoff strategy for redelivery after negative acknowledgment.
- newCheckpointConsumer(Schema) - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Create a checkpoint consumer builder with a specific schema.
- newClientBuilder() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- newMessage() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncProducer
-
Create a message builder for advanced message construction.
- newMessage() - Method in interface org.apache.pulsar.client.api.v5.Producer
-
Create a message builder for advanced message construction (key, properties, etc.).
- newProducer(Schema) - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Create a producer builder with a specific schema.
- newQueueConsumer(Schema) - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Create a queue consumer builder with a specific schema.
- newStreamConsumer(Schema) - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Create a stream consumer builder with a specific schema.
- newTransaction() - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Create a new transaction, blocking until it is ready.
- newTransactionAsync() - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Asynchronous counterpart of
PulsarClient.newTransaction(). - NONE - Enum constant in enum class org.apache.pulsar.client.api.v5.config.CompressionType
-
No compression.
- NONE - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- NotConnectedException() - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.NotConnectedException
- NotConnectedException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.NotConnectedException
- NotFoundException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.NotFoundException
O
- of(byte[]) - Static method in class org.apache.pulsar.client.api.v5.auth.EncryptionKey
-
Create an
EncryptionKeywith no metadata. - of(byte[], Map) - Static method in class org.apache.pulsar.client.api.v5.auth.EncryptionKey
-
Create an
EncryptionKeywith associated metadata. - of(String, String) - Static method in class org.apache.pulsar.client.api.v5.auth.HttpAuthHeaders
-
Create headers with a single entry.
- of(String, SchemaType, byte[], Map) - Static method in interface org.apache.pulsar.client.api.v5.schema.SchemaInfo
-
Build a
SchemaInfofrom its components. - of(Duration) - Static method in class org.apache.pulsar.client.api.v5.config.ProcessingTimeoutPolicy
-
Create a policy with just a timeout — the broker uses its default redelivery cadence (no extra backoff between retries).
- of(Map) - Static method in class org.apache.pulsar.client.api.v5.auth.HttpAuthHeaders
-
Create headers from a map.
- of(CompressionType) - Static method in class org.apache.pulsar.client.api.v5.config.CompressionPolicy
-
Create a compression policy with the given codec.
- ofBytes(long) - Static method in record class org.apache.pulsar.client.api.v5.config.MemorySize
-
Create a memory size from a number of bytes.
- ofDisabled() - Static method in class org.apache.pulsar.client.api.v5.config.BatchingPolicy
-
Batching disabled.
- ofDisabled() - Static method in class org.apache.pulsar.client.api.v5.config.ChunkingPolicy
-
Chunking disabled.
- ofGigabytes(long) - Static method in record class org.apache.pulsar.client.api.v5.config.MemorySize
-
Create a memory size from a number of gigabytes.
- ofKilobytes(long) - Static method in record class org.apache.pulsar.client.api.v5.config.MemorySize
-
Create a memory size from a number of kilobytes.
- ofMegabytes(long) - Static method in record class org.apache.pulsar.client.api.v5.config.MemorySize
-
Create a memory size from a number of megabytes.
- OPEN - Enum constant in enum class org.apache.pulsar.client.api.v5.Transaction.State
- openTelemetry() - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationInitContext
- openTelemetry() - Method in interface org.apache.pulsar.client.api.v5.internal.ClientAuthenticationServices
- openTelemetry(OpenTelemetry) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Provide a custom
OpenTelemetryinstance for metrics and tracing. - operationTimeout(Duration) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Timeout for client operations (e.g., creating producers/consumers).
- org.apache.pulsar.client.api.v5 - package org.apache.pulsar.client.api.v5
-
Pulsar Client API v5.
- org.apache.pulsar.client.api.v5.async - package org.apache.pulsar.client.api.v5.async
-
Asynchronous views of producers, consumers, and transactions.
- org.apache.pulsar.client.api.v5.auth - package org.apache.pulsar.client.api.v5.auth
-
Pluggable authentication (and end-to-end encryption) types for the v5 client (PIP-478).
- org.apache.pulsar.client.api.v5.config - package org.apache.pulsar.client.api.v5.config
-
Configuration value types and policy records.
- org.apache.pulsar.client.api.v5.internal - package org.apache.pulsar.client.api.v5.internal
-
Pulsar Client API v5.
- org.apache.pulsar.client.api.v5.schema - package org.apache.pulsar.client.api.v5.schema
-
Schema definitions for message serialization and deserialization.
P
- PemFileKeyProvider - Class in org.apache.pulsar.client.api.v5.auth
-
Batteries-included key provider that loads PEM-encoded keys from local files.
- PemFileKeyProvider.Builder - Class in org.apache.pulsar.client.api.v5.auth
-
Builder for
PemFileKeyProvider. - priorityLevel(int) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Priority level for this consumer (lower values mean higher priority for message dispatch).
- privateKey(String, Path) - Method in class org.apache.pulsar.client.api.v5.auth.PemFileKeyProvider.Builder
-
Register a private key file under the given name.
- privateKeyProvider() - Method in class org.apache.pulsar.client.api.v5.config.ConsumerEncryptionPolicy
- privateKeyProvider(PrivateKeyProvider) - Method in class org.apache.pulsar.client.api.v5.config.ConsumerEncryptionPolicy.Builder
-
Provider used to load private keys.
- PrivateKeyProvider - Interface in org.apache.pulsar.client.api.v5.auth
-
Consumer-side SPI: load a private key by name for end-to-end message decryption.
- processingTimeout(ProcessingTimeoutPolicy) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Optional safety net for slow / stalled consumers: see
ProcessingTimeoutPolicyfor the full semantics. - ProcessingTimeoutPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Optional safety net for slow / stalled queue consumers: if the application doesn't process and acknowledge a delivered message within
timeout, the client gives up on that delivery and asks the broker to redeliver it (to this consumer or, on a Shared subscription, to another consumer in the group). - ProcessingTimeoutPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
ProcessingTimeoutPolicy. - Producer<T> - Interface in org.apache.pulsar.client.api.v5
-
A producer publishes messages to a Pulsar topic.
- ProducerAccessMode - Enum Class in org.apache.pulsar.client.api.v5.config
-
Access mode for a producer on a topic.
- ProducerBuilder<T> - Interface in org.apache.pulsar.client.api.v5
-
Builder for configuring and creating a
Producer. - ProducerBusyException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.ProducerBusyException
- ProducerCryptoFailureAction - Enum Class in org.apache.pulsar.client.api.v5.auth
-
Action a producer takes when message encryption fails (e.g.
- ProducerEncryptionPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Producer-side end-to-end encryption configuration.
- ProducerEncryptionPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
ProducerEncryptionPolicy. - producerName() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The name of the producer that published this message.
- producerName() - Method in interface org.apache.pulsar.client.api.v5.Producer
-
The name of this producer (system-assigned or user-specified via
ProducerBuilder.producerName(String)). - producerName(String) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Set a custom producer name.
- ProducerQueueIsFullException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.ProducerQueueIsFullException
- properties() - Method in interface org.apache.pulsar.client.api.v5.Message
-
Application-defined properties attached to the message.
- properties() - Method in interface org.apache.pulsar.client.api.v5.schema.SchemaInfo
-
Additional properties associated with the schema.
- properties(Map) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
Add multiple properties to the consumer metadata.
- properties(Map) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Add multiple properties to the message.
- properties(Map) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Add multiple properties to the producer metadata.
- properties(Map) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Add multiple properties to the consumer metadata.
- properties(Map) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Add multiple properties to the consumer metadata.
- property(String, String) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
Add a single property to the consumer metadata.
- property(String, String) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Add a single property to the message.
- property(String, String) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Add a single property to the producer metadata.
- property(String, String) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Add a single property to the consumer metadata.
- property(String, String) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Add a single property to the consumer metadata.
- protobuf(Class) - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a Protobuf schema for a generated message class.
- PROTOBUF - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- PROTOBUF_NATIVE - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- protobufSchema(Class) - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- proxy(String, ProxyProtocol) - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy.Builder
-
Connect through a proxy.
- proxyProtocol() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- ProxyProtocol - Enum Class in org.apache.pulsar.client.api.v5.config
-
Protocol used when connecting through a proxy.
- proxyServiceUrl() - Method in class org.apache.pulsar.client.api.v5.config.ConnectionPolicy
- publicKey(String, Path) - Method in class org.apache.pulsar.client.api.v5.auth.PemFileKeyProvider.Builder
-
Register a public key file under the given name.
- publicKeyProvider() - Method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy
- publicKeyProvider(PublicKeyProvider) - Method in class org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy.Builder
-
Provider used to load public keys.
- PublicKeyProvider - Interface in org.apache.pulsar.client.api.v5.auth
-
Producer-side SPI: load a public key by name for end-to-end message encryption.
- publishTime() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The timestamp when the message was published by the broker.
- PulsarClient - Interface in org.apache.pulsar.client.api.v5
-
Entry point for the Pulsar client.
- PulsarClientBuilder - Interface in org.apache.pulsar.client.api.v5
-
Builder for configuring and creating a
PulsarClient. - PulsarClientException - Exception Class in org.apache.pulsar.client.api.v5
-
Base exception for all Pulsar client operations.
- PulsarClientException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException
- PulsarClientException(String, Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException
- PulsarClientException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException
- PulsarClientException.AlreadyClosedException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.AuthenticationException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.AuthorizationException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.ConnectException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.ConsumerBusyException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.CryptoException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.GettingAuthenticationDataException - Exception Class in org.apache.pulsar.client.api.v5
-
Transient failure while acquiring a credential (token endpoint timeout, ZTS unavailable).
- PulsarClientException.IncompatibleSchemaException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.InvalidConfigurationException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.InvalidServiceURLException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.MemoryBufferIsFullException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.NotConnectedException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.NotFoundException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.ProducerBusyException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.ProducerQueueIsFullException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.TimeoutException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.TopicTerminatedException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.TransactionConflictException - Exception Class in org.apache.pulsar.client.api.v5
- PulsarClientException.UnsupportedAuthenticationException - Exception Class in org.apache.pulsar.client.api.v5
-
The requested authentication capability is not supported by the plugin (used by the legacy v4 adapter when a wrapped v4 provider returns null/false from the corresponding
hasData*method). - PulsarClientProvider - Interface in org.apache.pulsar.client.api.v5.internal
-
Service Provider Interface for the Pulsar client implementation.
- PulsarClientProvider.Holder - Class in org.apache.pulsar.client.api.v5.internal
-
Lazy initialization holder for the provider singleton.
Q
- QueueConsumer<T> - Interface in org.apache.pulsar.client.api.v5
-
A consumer for queue (unordered) consumption with broker-managed position tracking.
- QueueConsumerBuilder<T> - Interface in org.apache.pulsar.client.api.v5
-
Builder for configuring and creating a
QueueConsumer.
R
- readCompacted(boolean) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Whether to read from the compacted topic (only latest value per key).
- receive() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncCheckpointConsumer
-
Receive a single message asynchronously.
- receive() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncQueueConsumer
-
Receive a single message asynchronously.
- receive() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncStreamConsumer
-
Receive a single message asynchronously.
- receive() - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumer
-
Receive a single message, blocking indefinitely.
- receive() - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
Receive a single message, blocking indefinitely.
- receive() - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
Receive a single message, blocking indefinitely.
- receive(Duration) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncCheckpointConsumer
-
Receive a single message, completing with
nullif the timeout elapses. - receive(Duration) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncStreamConsumer
-
Receive a single message, completing with
nullif the timeout elapses without a message becoming available. - receive(Duration) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumer
-
Receive a single message, blocking up to the given timeout.
- receive(Duration) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
Receive a single message, blocking up to the given timeout.
- receive(Duration) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
Receive a single message, blocking up to the given timeout.
- receiveMulti(int, Duration) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncCheckpointConsumer
-
Receive a batch of messages asynchronously.
- receiveMulti(int, Duration) - Method in interface org.apache.pulsar.client.api.v5.async.AsyncStreamConsumer
-
Receive a batch of messages asynchronously.
- receiveMulti(int, Duration) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumer
-
Receive a batch of messages, blocking up to the given timeout.
- receiveMulti(int, Duration) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
Receive a batch of messages, blocking up to the given timeout.
- receiverQueueSize(int) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Size of the receiver queue.
- redeliveryBackoff() - Method in class org.apache.pulsar.client.api.v5.config.ProcessingTimeoutPolicy
- redeliveryBackoff(BackoffPolicy) - Method in class org.apache.pulsar.client.api.v5.config.ProcessingTimeoutPolicy.Builder
-
Optional backoff applied between redeliveries.
- redeliveryCount() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The number of times the broker has redelivered this message.
- replicatedFrom() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The cluster from which this message was replicated, if applicable.
- replicateSubscriptionState(boolean) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Whether the subscription cursor should be replicated to other clusters in a geo-replication setup.
- replicateSubscriptionState(boolean) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Enable replication of subscription state across geo-replicated clusters.
- replicationClusters(List) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Restrict geo-replication to the specified clusters only.
- requestUri() - Method in interface org.apache.pulsar.client.api.v5.auth.HttpAuthCallContext
- respondToChallengeAsync(AuthenticationCallContext, AuthChallenge) - Method in interface org.apache.pulsar.client.api.v5.auth.BinaryAuthChallengeHandler
-
Respond to a binary-protocol
CommandAuthChallenge. - respondToHttpChallengeAsync(HttpAuthCallContext) - Method in interface org.apache.pulsar.client.api.v5.auth.HttpAuthChallengeHandler
-
Compute the headers for the next round.
- retryLetterTopic() - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy
- retryLetterTopic(String) - Method in class org.apache.pulsar.client.api.v5.config.DeadLetterPolicy.Builder
-
Custom retry letter topic.
S
- scheduler() - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationInitContext
-
Scheduler for delayed / periodic authentication work (e.g.
- scheduler() - Method in interface org.apache.pulsar.client.api.v5.internal.ClientAuthenticationServices
- schema() - Method in interface org.apache.pulsar.client.api.v5.schema.SchemaInfo
-
The raw schema definition bytes (e.g., Avro schema JSON, Protobuf descriptor).
- Schema<T> - Interface in org.apache.pulsar.client.api.v5.schema
-
Defines how message values are serialized to bytes and deserialized from bytes.
- schemaInfo() - Method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
The schema descriptor for broker-side negotiation.
- SchemaInfo - Interface in org.apache.pulsar.client.api.v5.schema
-
Describes a schema for broker-side schema negotiation and compatibility checks.
- schemaType() - Method in interface org.apache.pulsar.client.api.v5.schema.GenericRecord
-
The schema type of the decoded value.
- SchemaType - Enum Class in org.apache.pulsar.client.api.v5.schema
-
Types of schema supported by Pulsar.
- send() - Method in interface org.apache.pulsar.client.api.v5.async.AsyncMessageBuilder
-
Send the message asynchronously.
- send() - Method in interface org.apache.pulsar.client.api.v5.MessageBuilder
-
Send the message synchronously and return its message ID.
- SEND_UNENCRYPTED - Enum constant in enum class org.apache.pulsar.client.api.v5.auth.ProducerCryptoFailureAction
-
Send the message unencrypted instead of failing.
- sendTimeout(Duration) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
Timeout for a send operation.
- sequenceId() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The producer-assigned sequence ID for deduplication.
- sequenceId(long) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Set the sequence ID for producer deduplication.
- serverChallengeHeaders() - Method in interface org.apache.pulsar.client.api.v5.auth.HttpAuthCallContext
-
For SASL-style HTTP challenge/response: the challenge headers from the server's prior
401response (for exampleSASL-Token/State/SASL-Server-ID). - serviceUrl(String) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Set the Pulsar service URL — the broker's binary-protocol endpoint.
- setStateObject(Class, T) - Method in interface org.apache.pulsar.client.api.v5.auth.AuthenticationCallContext
-
Store a state object keyed by its (or any) class; a
nullvalue removes the entry. - setStateObject(Class, T) - Method in interface org.apache.pulsar.client.api.v5.auth.HttpAuthCallContext
-
Store a state object keyed by its (or any) class; a
nullvalue removes the entry. - SHARED - Enum constant in enum class org.apache.pulsar.client.api.v5.config.ProducerAccessMode
-
Multiple producers can publish on the topic.
- shortSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- shutdown() - Method in interface org.apache.pulsar.client.api.v5.PulsarClient
-
Shutdown the client instance.
- SinglePassAuthentication - Interface in org.apache.pulsar.client.api.v5.auth
-
Convenience composite: a single-pass credential served over both transports (PIP-478).
- size() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The uncompressed size of the message payload in bytes.
- SNAPPY - Enum constant in enum class org.apache.pulsar.client.api.v5.config.CompressionType
-
Snappy compression.
- SNI - Enum constant in enum class org.apache.pulsar.client.api.v5.config.ProxyProtocol
- startPosition(Checkpoint) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
Set the initial position for this consumer.
- state() - Method in interface org.apache.pulsar.client.api.v5.Transaction
-
The current state of this transaction.
- StreamConsumer<T> - Interface in org.apache.pulsar.client.api.v5
-
A consumer for streaming (ordered) consumption with broker-managed position tracking.
- StreamConsumerBuilder<T> - Interface in org.apache.pulsar.client.api.v5
-
Builder for configuring and creating a
StreamConsumer. - string() - Static method in interface org.apache.pulsar.client.api.v5.schema.Schema
-
Get a schema for UTF-8 strings.
- STRING - Enum constant in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
- stringSchema() - Method in interface org.apache.pulsar.client.api.v5.internal.PulsarClientProvider
- subscribe() - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Subscribe and create the queue consumer, blocking until ready.
- subscribe() - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Subscribe and create the stream consumer, blocking until ready.
- subscribeAsync() - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Subscribe and create the queue consumer asynchronously.
- subscribeAsync() - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Subscribe and create the stream consumer asynchronously.
- subscription() - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
The subscription name.
- subscription() - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
The subscription name.
- subscriptionInitialPosition(SubscriptionInitialPosition) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Initial position when the subscription is first created.
- subscriptionInitialPosition(SubscriptionInitialPosition) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Initial position when the subscription is first created (no existing cursor).
- SubscriptionInitialPosition - Enum Class in org.apache.pulsar.client.api.v5.config
-
Initial position for a new subscription that has no existing cursor.
- subscriptionName(String) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
The subscription name.
- subscriptionName(String) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
The subscription name.
- subscriptionProperties(Map) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Properties to attach to the subscription.
- subscriptionProperties(Map) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Properties to attach to the subscription.
T
- TIMED_OUT - Enum constant in enum class org.apache.pulsar.client.api.v5.Transaction.State
- timeout() - Method in class org.apache.pulsar.client.api.v5.config.ProcessingTimeoutPolicy
- timeout() - Method in class org.apache.pulsar.client.api.v5.config.TransactionPolicy
- timeout(Duration) - Method in class org.apache.pulsar.client.api.v5.config.ProcessingTimeoutPolicy.Builder
-
Processing-timeout duration — how long the client waits for the application to ack before asking the broker to redeliver.
- timeout(Duration) - Method in class org.apache.pulsar.client.api.v5.config.TransactionPolicy.Builder
-
Transaction timeout.
- TimeoutException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.TimeoutException
- TimeoutException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.TimeoutException
- tls() - Static method in class org.apache.pulsar.client.api.v5.auth.AuthenticationFactory
-
Create the built-in TLS mutual-authentication marker plugin (PIP-478).
- tlsFactory(PulsarTlsFactory) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Provide a custom
PulsarTlsFactoryimplementation (PIP-478), for advanced deployments that source TLS material from something other than files (a KMS, an HSM-backed key manager, a per-destination workload identity). - tlsPolicy(TlsPolicy) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Configure TLS for the client connection (PIP-478), using the neutral
TlsPolicyvalue shared by the client builder and the server components. - tlsPolicy(TlsPurpose, TlsPolicy) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Configure TLS for a specific
TlsPurpose(PIP-478). - toByteArray() - Method in interface org.apache.pulsar.client.api.v5.Checkpoint
-
Serialize this checkpoint for external storage.
- toByteArray() - Method in interface org.apache.pulsar.client.api.v5.MessageId
-
Serialize this message ID to a byte array for external storage.
- token(String) - Static method in class org.apache.pulsar.client.api.v5.auth.AuthenticationFactory
-
Create token-based authentication with a static token.
- token(Supplier) - Static method in class org.apache.pulsar.client.api.v5.auth.AuthenticationFactory
-
Create token-based authentication with a dynamic token supplier.
- topic() - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumer
-
The topic this consumer reads from.
- topic() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The topic this message was published to.
- topic() - Method in interface org.apache.pulsar.client.api.v5.Producer
-
The topic this producer is attached to.
- topic() - Method in interface org.apache.pulsar.client.api.v5.QueueConsumer
-
The topic this consumer is subscribed to.
- topic() - Method in interface org.apache.pulsar.client.api.v5.StreamConsumer
-
The topic this consumer is subscribed to.
- topic(String) - Method in interface org.apache.pulsar.client.api.v5.CheckpointConsumerBuilder
-
The topic to consume from.
- topic(String) - Method in interface org.apache.pulsar.client.api.v5.ProducerBuilder
-
The topic to produce to.
- topic(String) - Method in interface org.apache.pulsar.client.api.v5.QueueConsumerBuilder
-
Subscribe to a single scalable topic by name.
- topic(String) - Method in interface org.apache.pulsar.client.api.v5.StreamConsumerBuilder
-
Subscribe to a single scalable topic by name.
- TopicTerminatedException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.TopicTerminatedException
- toString() - Method in record class org.apache.pulsar.client.api.v5.auth.AuthChallenge
-
Returns a string representation of this record class.
- toString() - Method in record class org.apache.pulsar.client.api.v5.auth.BinaryAuthData
-
Returns a string representation of this record class.
- toString() - Method in record class org.apache.pulsar.client.api.v5.auth.ChallengeResponse
-
Returns a string representation of this record class.
- toString() - Method in class org.apache.pulsar.client.api.v5.auth.HttpAuthHeaders
- toString() - Method in record class org.apache.pulsar.client.api.v5.config.MemorySize
- toString() - Method in record class org.apache.pulsar.client.api.v5.schema.Field
-
Returns a string representation of this record class.
- toString() - Method in record class org.apache.pulsar.client.api.v5.schema.KeyValue
-
Returns a string representation of this record class.
- transaction(Transaction) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Associate this message with a transaction.
- Transaction - Interface in org.apache.pulsar.client.api.v5
-
A Pulsar transaction handle.
- Transaction.State - Enum Class in org.apache.pulsar.client.api.v5
- TransactionConflictException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.TransactionConflictException
- transactionPolicy(TransactionPolicy) - Method in interface org.apache.pulsar.client.api.v5.PulsarClientBuilder
-
Set the transaction policy.
- TransactionPolicy - Class in org.apache.pulsar.client.api.v5.config
-
Transaction configuration for the Pulsar client.
- TransactionPolicy.Builder - Class in org.apache.pulsar.client.api.v5.config
-
Builder for
TransactionPolicy. - type() - Method in class org.apache.pulsar.client.api.v5.config.CompressionPolicy
- type() - Method in interface org.apache.pulsar.client.api.v5.schema.SchemaInfo
-
The type of the schema.
- type(CompressionType) - Method in class org.apache.pulsar.client.api.v5.config.CompressionPolicy.Builder
-
Compression codec to use for message payloads.
U
- UnsupportedAuthenticationException(String) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.UnsupportedAuthenticationException
- UnsupportedAuthenticationException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.v5.PulsarClientException.UnsupportedAuthenticationException
V
- v5Authentication() - Method in interface org.apache.pulsar.client.api.v5.internal.V5AuthenticationProvider
-
The v5-native authentication body this v4 plugin delegates to.
- V5AuthenticationProvider - Interface in org.apache.pulsar.client.api.v5.internal
-
Implemented by a legacy v4
org.apache.pulsar.client.api.Authenticationthat owns a v5-native body, so the client can drive the v5 body directly instead of bridging the v4 plugin (PIP-478). - value() - Method in interface org.apache.pulsar.client.api.v5.Message
-
The deserialized value of the message according to the schema.
- value() - Method in record class org.apache.pulsar.client.api.v5.schema.KeyValue
-
Returns the value of the
valuerecord component. - value(T) - Method in interface org.apache.pulsar.client.api.v5.MessageMetadata
-
Set the message value.
- valueOf(String) - Static method in enum class org.apache.pulsar.client.api.v5.auth.ConsumerCryptoFailureAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.pulsar.client.api.v5.auth.ProducerCryptoFailureAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.pulsar.client.api.v5.config.CompressionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.pulsar.client.api.v5.config.ProducerAccessMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.pulsar.client.api.v5.config.ProxyProtocol
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.pulsar.client.api.v5.config.SubscriptionInitialPosition
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.pulsar.client.api.v5.Transaction.State
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.apache.pulsar.client.api.v5.auth.ConsumerCryptoFailureAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.pulsar.client.api.v5.auth.ProducerCryptoFailureAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.pulsar.client.api.v5.config.CompressionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.pulsar.client.api.v5.config.ProducerAccessMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.pulsar.client.api.v5.config.ProxyProtocol
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.pulsar.client.api.v5.config.SubscriptionInitialPosition
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.pulsar.client.api.v5.schema.SchemaType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.pulsar.client.api.v5.Transaction.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WAIT_FOR_EXCLUSIVE - Enum constant in enum class org.apache.pulsar.client.api.v5.config.ProducerAccessMode
-
Only one producer is allowed on the topic.
Z
- ZLIB - Enum constant in enum class org.apache.pulsar.client.api.v5.config.CompressionType
-
ZLIB compression.
- ZSTD - Enum constant in enum class org.apache.pulsar.client.api.v5.config.CompressionType
-
Zstandard compression.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form