Package log defines the logger interfaces used by pulsar client.

DeserializeMessageID reconstruct a MessageID object from its serialized representation.

EarliestMessageID returns a messageID that points to the earliest message available in a topic.

LatestMessageID returns a messageID that points to the latest message.

NewAuthentication Creates an authentication by name and params.

NewAuthenticationAthenz Creates Athenz Authentication provider.

NewAuthenticationBasic Creates Basic Authentication provider.

NewAuthenticationFromTLSCertSupplier Create new Authentication provider with specified TLS certificate supplier.

NewAuthenticationOAuth2 Creates OAuth2 Authentication provider.

NewAuthenticationTLS Creates new Authentication provider with specified TLS certificate and private key.

NewAuthenticationToken Creates new Authentication provider with specified auth token.

NewAuthenticationTokenFromFile Creates new Authentication provider with specified auth token from a file.

NewAuthenticationTokenFromSupplier returns a token auth provider that gets the token data from a user supplied function.

NewAvroSchema creates a new AvroSchema Note: the function will panic if creation of codec fails.

NewAvroSchemaWithValidation creates a new AvroSchema and error to indicate codec failure.

NewClient Creates a pulsar client instance.

NewDefaultRouter set the message routing mode for the partitioned producer.

NewJSONSchema creates a new JSONSchema Note: the function will panic if creation of codec fails.

NewJSONSchemaWithValidation creates a new JSONSchema and error to indicate codec failure.

NewKeySharedPolicySticky construct KeySharedPolicy in Sticky mode with hashRanges formed in value pair list: [x1, x2, y1, y2, z1, z2], and must not overlap with each others.

NewMessageID Custom Create MessageID.

NewProtoSchema creates a new ProtoSchema Note: the function will panic if creation of codec fails.

NewProtoSchemaWithValidation creates a new ProtoSchema and error to indicate codec failure.

AddToBatchFailed failed to add sendRequest to batchBuilder.

AlreadyClosedError producer/consumer is already closed and not accepting any operation.

AuthenticationError means authentication failed on broker.

AuthorizationError client is not authorized to create producer/consumer.

.

Auto Consume Type.

Auto Publish Type.

Serialize and deserialize via Avro.

Higher compression rate, but slower.

.

BrokerMetadataError broker failed in updating metadata.

BrokerPersistenceError broker failed to persist entry.

A bytes array.

ChecksumError corrupt message checksum failure.

ClientMemoryBufferIsFull client limit buffer is full.

ConnectError means failed to connect to broker.

ConsumerBusy means Exclusive consumer is already connected.

ConsumerClosed means consumer already been closed.

ConsumerNotFound consumer not found.

ConsumerNotInitialized consumer is not initialized.

CryptoError error when crypto operation fails.

Default compression level.

A double number.

Make the subscription to be backed by a durable cursor that will retain messages and persist the current position.

ErrorGettingAuthenticationData client cannot find authorization data.

Exclusive there can be only 1 consumer on the same topic with the same subscription name.

Failover subscription mode, multiple consumer will be able to use the same subscription name but only 1 consumer will receive the messages.

Faster compression, with lower compression ratio.

A float number.

A 16-byte integer.

A 32-byte integer.

A 64-byte integer.

A 8-byte integer.

InvalidBatchBuilderType invalid batch builder type.

InvalidConfiguration means invalid configuration.

InvalidMessage error in publishing an already used message.

InvalidStatus means the component status is not as expected.

InvalidTopicName means invalid topic name.

InvalidURL means Client Initialized with Invalid Broker Url (VIP Url passed to Client Constructor).

JavaStringHash and Java String.hashCode() equivalent.

JSON object encoding and validation.

KeyShared subscription mode, multiple consumer will be able to use the same subscription and all messages with the same key will be dispatched to only one consumer.

KeySharedPolicyModeAutoSplit Auto split hash range key shared policy.

KeySharedPolicyModeSticky is Sticky attach topic with fixed hash range.

A Schema that contains Key Schema and Value Schema.

LookupError means broker lookup failed.

MaxConcurrentOperationsReached indicates that the maximum number of concurrent operations has been reached.

MessageTooBig trying to send a messages exceeding the max size.

Label metrics by tenant and namespace.

Do not add additional labels to metrics.

Label metrics by tenant.

Label metrics by topic.

Murmur3_32Hash use Murmur3 hashing function.

Lightweight subscription mode that doesn't have a durable cursor associated.

No schema defined.

NotConnectedError producer/consumer is not currently connected to broker.

Ok means no errors.

OperationNotSupported operation not supported.

ProducerAccessModeExclusive is required exclusive access for producer.

ProducerAccessModeShared is default multiple producers can publish on a topic.

ProducerAccessModeWaitForExclusive is pending until producer can acquire exclusive access.

ProducerBlockedQuotaExceededError producer is blocked.

ProducerBlockedQuotaExceededException producer is getting exception.

ProducerClosed means producer already been closed.

ProducerFenced When a producer asks and fail to get exclusive producer access, or loses the exclusive status after a reconnection, the broker will use this error to indicate that this producer is now permanently fenced.

ProducerNotInitialized producer is not initialized.

ProducerQueueIsFull producer queue is full.

Protobuf message encoding and decoding.

Protobuf native message encoding and decoding.

ReadError means failed to read from socket.

SchemaFailure means the payload could not be encoded using the Schema.

SeekFailed seek failed.

ServiceUnitNotReady unloaded between client did lookup and producer/consumer got created.

Shared subscription mode, multiple consumer will be able to use the same subscription name and the messages will be dispatched according to a round-robin rotation between the connected consumers.

Simple String encoding with UTF-8.

SubscriptionNotFound subscription not found.

SubscriptionPositionEarliest is the earliest position which means the start consuming position will be the first message.

SubscriptionPositionLatest is the latest position which means the start consuming position will be the last message.

TimeoutError means operation timed out.

TooManyLookupRequestException too many concurrent LookupRequest.

TopicNotFound topic not found.

TopicTerminated topic was already terminated.

TransactionCoordinatorAssign is the transaction_impl coordinator topic which is used to look up the broker where the TC located.

TransactionCoordinatorNotEnabled indicates that the transaction coordinator is not enabled.

TransactionNoFoundError The transaction is not exist in the transaction coordinator, It may be an error txn or already ended.

TxnAborted The state of the transaction will be TxnAborted after the abort method is executed success.

TxnAborting The state of the transaction will be TxnAborting after the abort method is called.

TxnCommitted The state of the transaction will be TxnCommitted after the commit method is executed success.

TxnCommitting The state of the transaction will be TxnCommitting after the commit method is called.

TxnError The state of the transaction will be TxnError after the operation of transaction get a non-retryable error.

TxnOpen The transaction in TxnOpen state can be used to send/ack messages.

TxnTimeout The state of the transaction will be TxnTimeout after the transaction timeout.

UnknownError means unknown error happened on broker.

UnsupportedVersionError when an older client/version doesn't support a required feature.

AckGroupingOptions controls how to group ACK requests If maxSize is 0 or 1, any ACK request will be sent immediately.

ClientOptions is used to construct a Pulsar Client instance.

ConsumerMessage represents a pair of a Consumer and Message.

ConsumerOptions is used to configure and create instances of Consumer.

DLQPolicy represents the configuration for the Dead Letter Queue consumer policy.

EncryptionContext It will be used to decrypt message outside of this client.

EncryptionKey Encryption key used to encrypt the message payload.

Error implement error interface, composed of two parts: msg and result.

KeySharedPolicy for KeyShared subscription.

MessageDecryptionInfo encryption related fields required by the consumer to decrypt the message.

ProducerEncryptionInfo encryption related fields required by the producer.

ProducerMessage abstraction used in Pulsar producer.

ReaderMessage packages Reader and Message as a struct to use.

ReaderOptions represents Reader options to use.

Encapsulates data around the schema definition.

TableViewOptions contains the options for creating a TableView.

TxnID An identifier for representing a transaction.

Authentication Opaque interface that represents the authentication credentials.

Client represents a pulsar client.

Consumer is an interface that abstracts behavior of Pulsar's consumer.

Message abstraction used in Pulsar.

MessageID identifier for a particular message.

NackBackoffPolicy is a interface for custom message negativeAcked policy, users can specify a NackBackoffPolicy for a consumer.

Producer is used to publish messages on a topic.

Reader can be used to scan through all the messages currently available in a topic.

TableView provides a key-value map view of a compacted topic.

TopicMessageID defined the correspondence between topic and MessageID.

TopicMetadata represents a topic metadata.

Transaction used to guarantee exactly-once.

MetricsCardinality represents the specificty of labels on a per-metric basis.

Result used to represent pulsar processing is an alias of type int.

SubscriptionType of subscription supported by Pulsar.

TxnState The state of the transaction.