All Classes

Class	Description
AuthData	Authentication data.
Authentication	Interface of authentication providers.
AuthenticationDataProvider	Interface for accessing data which are used in variety of authentication schemes on client side.
AuthenticationFactory	Factory class that allows to create Authentication instances for all the supported authentication methods.
BatcherBuilder	Batcher builder.
BatchMessageContainer	Batch message container for individual messages being published until they are batched and sent to broker.
BatchReceivePolicy	Configuration for message batch receive Consumer.batchReceive() Consumer.batchReceiveAsync().
BatchReceivePolicy.Builder	Builder of BatchReceivePolicy.
ClientBuilder	Builder interface that is used to configure and construct a PulsarClient instance.
CompressionType	The compression type that can be specified on a Producer.
Consumer<T>	An interface that abstracts behavior of Pulsar's consumer.
ConsumerBuilder<T>	ConsumerBuilder is used to configure and create instances of Consumer.
ConsumerCryptoFailureAction	The action a consumer should take when a consumer receives a message that it cannot decrypt.
ConsumerEventListener	Listener on the consumer state changes.
ConsumerInterceptor<T>	A plugin interface that allows you to intercept (and possibly mutate) messages received by the consumer.
ConsumerStats	Consumer statistics recorded by client.
CryptoKeyReader	Interface that abstracts the access to a key store.
DeadLetterPolicy	Configuration for the "dead letter queue" feature in consumer.
DefaultImplementation	This class loads the implementation for PulsarClientImplementationBinding and allows you to decouple the API from the actual implementation.
EncodedAuthenticationParameterSupport	Support for encoded authentication configuration parameters.
EncryptionContext	Class representing an encryption context.
EncryptionContext.EncryptionKey	Encryption key with metadata.
EncryptionKeyInfo	EncryptionKeyInfo contains the encryption key and corresponding metadata which contains additional information about the key such as version, timestamp.
Field	A field in a record, consisting of a field name, index, and Schema for the field value.
FieldSchemaBuilder<T extends FieldSchemaBuilder<T>>	Build a field for a record.
GenericObject	This is an abstraction over the logical value that is store into a Message.
GenericRecord	An interface represents a message with schema.
GenericRecordBuilder	Generic Record Builder to build a GenericRecord.
GenericSchema<T extends GenericRecord>	A schema that serializes and deserializes between GenericRecord and bytes.
HashingScheme	Standard hashing functions available when choosing the partition to use for a particular message.
InterfaceAudience	Annotation to inform users of a package, class or method's intended audience.
InterfaceAudience.LimitedPrivate	Intended for use only within the project(s) specified in the annotation.
InterfaceAudience.Private	Intended for use only within the project itself.
InterfaceAudience.Public	Intended for use by any project or application.
InterfaceStability	Annotation to inform users of how much to rely on a particular package, class or method not changing over time.
InterfaceStability.Evolving	Evolving, but can break compatibility at minor release (i.e.
InterfaceStability.Stable	Can evolve while retaining compatibility for minor release boundaries.; can break compatibility only at major release (ie.
InterfaceStability.Unstable	No guarantee is provided as to reliability or stability across any level of release granularity.
KeySharedMode	KeyShared mode of KeyShared subscription.
KeySharedPolicy	KeyShared policy for KeyShared subscription.
KeySharedPolicy.KeySharedPolicyAutoSplit	Auto split hash range key shared policy.
KeySharedPolicy.KeySharedPolicySticky	Sticky attach topic with fixed hash range.
KeyStoreParams	KeyStore parameters used for tls authentication.
KeyValue<K,V>	A simple KeyValue class.
KeyValue.KeyValueDecoder<K,V>	Decoder to decode key/value bytes.
KeyValueEncodingType	Encoding types of supported KeyValueSchema for Pulsar messages.
KeyValueSchema<K,V>	This interface models a Schema that is composed of two parts.
Message<T>	The message abstraction used in Pulsar.
MessageCrypto<MetadataT,BuilderT>	Interface that abstracts the method to encrypt/decrypt message for End to End Encryption.
MessageId	Opaque unique identifier of a single message
MessageListener<T>	A listener that will be called in order for every message received.
MessagePayload	The abstraction of a message's payload.
MessagePayloadContext	The context of the message payload, which usually represents a batched message (batch) or a single message.
MessagePayloadFactory	The factory class of MessagePayload.
MessagePayloadProcessor	The processor to process a message payload.
MessageRouter	Interface for custom message router that can be passed to a producer to select the partition that a particular messsage should be published on.
MessageRoutingMode	Default routing mode for messages to partition.
Messages<T>	A container that holds the list Message for a topic.
Producer<T>	Producer is used to publish messages on a topic.
ProducerAccessMode	The type of access to the topic that the producer requires.
ProducerBuilder<T>	ProducerBuilder is used to configure and create instances of Producer.
ProducerCryptoFailureAction	The action the producer will take in case of encryption failures.
ProducerInterceptor	A plugin interface that allows you to intercept (and possibly mutate) the messages received by the producer before they are published to the Pulsar brokers.
ProducerInterceptor<T>	Deprecated.
ProducerInterceptorWrapper	A wrapper for old style producer interceptor.
ProducerStats	Producer statistics recorded by client.
ProxyProtocol	Protcol type to determine type of proxy routing when client connects to proxy using {@link ClientBuilder::proxyServiceUrl}.
PulsarClient	Class that provides a client interface to Pulsar.
PulsarClientException	Base type of exception thrown by Pulsar client.
PulsarClientException.AlreadyClosedException	Already closed exception thrown by Pulsar client.
PulsarClientException.AuthenticationException	Authentication exception thrown by Pulsar client.
PulsarClientException.AuthorizationException	Authorization exception thrown by Pulsar client.
PulsarClientException.BrokerMetadataException	Broker metadata exception thrown by Pulsar client.
PulsarClientException.BrokerPersistenceException	Broker persistence exception thrown by Pulsar client.
PulsarClientException.ChecksumException	Checksum exception thrown by Pulsar client.
PulsarClientException.ConnectException	Connect exception thrown by Pulsar client.
PulsarClientException.ConsumerAssignException	Consumer assign exception thrown by Pulsar client.
PulsarClientException.ConsumerBusyException	Consumer busy exception thrown by Pulsar client.
PulsarClientException.CryptoException	Crypto exception thrown by Pulsar client.
PulsarClientException.GettingAuthenticationDataException	Getting authentication data exception thrown by Pulsar client.
PulsarClientException.IncompatibleSchemaException	Incompatible schema exception thrown by Pulsar client.
PulsarClientException.InvalidConfigurationException	Invalid Configuration exception thrown by Pulsar client.
PulsarClientException.InvalidMessageException	Invalid message exception thrown by Pulsar client.
PulsarClientException.InvalidServiceURL	Invalid Service URL exception thrown by Pulsar client.
PulsarClientException.InvalidTopicNameException	Invalid topic name exception thrown by Pulsar client.
PulsarClientException.LookupException	Lookup exception thrown by Pulsar client.
PulsarClientException.MemoryBufferIsFullError	Memory buffer full error thrown by Pulsar client.
PulsarClientException.MessageAcknowledgeException	Consumer assign exception thrown by Pulsar client.
PulsarClientException.NotAllowedException	Not allowed exception thrown by Pulsar client.
PulsarClientException.NotConnectedException	Not connected exception thrown by Pulsar client.
PulsarClientException.NotFoundException	Not Found exception thrown by Pulsar client.
PulsarClientException.NotSupportedException	Not supported exception thrown by Pulsar client.
PulsarClientException.ProducerBlockedQuotaExceededError	Producer blocked quota exceeded error thrown by Pulsar client.
PulsarClientException.ProducerBlockedQuotaExceededException	Producer blocked quota exceeded exception thrown by Pulsar client.
PulsarClientException.ProducerBusyException	Producer busy exception thrown by Pulsar client.
PulsarClientException.ProducerFencedException	Producer fenced exception thrown by Pulsar client.
PulsarClientException.ProducerQueueIsFullError	Full producer queue error thrown by Pulsar client.
PulsarClientException.TimeoutException	Timeout exception thrown by Pulsar client.
PulsarClientException.TooManyRequestsException	Too many requests exception thrown by Pulsar client.
PulsarClientException.TopicDoesNotExistException	Topic does not exist and cannot be created.
PulsarClientException.TopicTerminatedException	Topic terminated exception thrown by Pulsar client.
PulsarClientException.TransactionConflictException	Consumer assign exception thrown by Pulsar client.
PulsarClientException.UnsupportedAuthenticationException	Unsupported authentication exception thrown by Pulsar client.
PulsarClientImplementationBinding	Helper class for class instantiations and it also contains methods to work with schemas.
Range	Int range.
Reader<T>	A Reader can be used to scan through all the messages currently available in a topic.
ReaderBuilder<T>	ReaderBuilder is used to configure and create instances of Reader.
ReaderListener<T>	A listener that will be called in order for every message received.
RecordSchemaBuilder	Building the schema for a GenericRecord.
RegexSubscriptionMode	When subscribing to topics using a regular expression, one can specify to only pick a certain type of topics.
Schema<T>	Message schema definition.
SchemaBuilder	Builder to build schema.
SchemaDefinition<T>	Interface for schema definition.
SchemaDefinitionBuilder<T>	Builder to build schema definition SchemaDefinition.
SchemaInfo	Information about the schema.
SchemaInfo.SchemaInfoBuilder
SchemaInfoProvider	Schema Provider.
SchemaInfoWithVersion	Data structure representing a schema information including its version.
SchemaReader<T>	Deserialize messages from bytes.
SchemaSerializationException	Schema serialization exception.
SchemaType	Types of supported schema for Pulsar messages.
SchemaWriter<T>	Serialize messages into bytes.
ServiceUrlProvider	The provider to provide the service url.
SizeUnit	Size unit converter.
SubscriptionInitialPosition	When creating a consumer, if the subscription does not exist, a new subscription will be created.
SubscriptionMode	Types of subscription mode supported by Pulsar.
SubscriptionType	Types of subscription supported by Pulsar.
TopicMetadata	Metadata of a topic that can be used for message routing.
Transaction	The class represents a transaction within Pulsar.
TransactionBufferClient	The transaction buffer client to commit and abort transactions on topics or subscription.
TransactionBufferClientException	Exceptions for transaction buffer client.
TransactionBufferClientException.ReachMaxPendingOpsException	Thrown when transaction buffer op over max pending numbers.
TransactionBufferClientException.RequestTimeoutException	Thrown when operation timeout.
TransactionBuilder	The builder to build a transaction for Pulsar.
TransactionCoordinatorClient	Transaction coordinator client.
TransactionCoordinatorClient.State	State of the transaction coordinator client.
TransactionCoordinatorClientException	Exceptions for transaction coordinator client.
TransactionCoordinatorClientException.CoordinatorClientStateException	Thrown when transaction coordinator with unexpected state.
TransactionCoordinatorClientException.CoordinatorNotFoundException	Thrown when transaction coordinator not found in broker side.
TransactionCoordinatorClientException.InvalidTxnStatusException	Thrown when transaction switch to a invalid status.
TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException	Thrown when transaction meta store handler not exists.
TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException	Thrown when send request to transaction meta store but the transaction meta store handler not ready.
TransactionCoordinatorClientException.TransactionNotFoundException	Thrown when transaction not found in transaction coordinator.
TxnID	An identifier for representing a transaction.
TypedMessageBuilder<T>	Message builder that constructs a message to be published through a producer.