Skip navigation links
A B C D E F G H I J K L M N O P R S T U V 

A

acknowledge(Message<?>) - Method in interface org.apache.pulsar.client.api.Consumer
Acknowledge the consumption of a single message
acknowledge(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
Acknowledge the consumption of a single message, identified by its MessageId
acknowledgeAsync(Message<?>) - Method in interface org.apache.pulsar.client.api.Consumer
Asynchronously acknowledge the consumption of a single message
acknowledgeAsync(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
Asynchronously acknowledge the consumption of a single message
acknowledgeCumulative(Message<?>) - Method in interface org.apache.pulsar.client.api.Consumer
Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
acknowledgeCumulative(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
acknowledgeCumulativeAsync(Message<?>) - Method in interface org.apache.pulsar.client.api.Consumer
Asynchronously Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
acknowledgeCumulativeAsync(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
Asynchronously Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
acknowledgmentGroupTime(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Group the consumer acknowledgments for the specified time.
ackTimeout(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Set the timeout for unacked messages, truncated to the nearest millisecond.
addEncryptionKey(String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Add public encryption key, used by producer to encrypt the data key.
addEncryptionKey(String) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Add public encryption key, used by producer to encrypt the data key.
allowTlsInsecureConnection(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false)
AlreadyClosedException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.AlreadyClosedException
 
Authentication - Interface in org.apache.pulsar.client.api
Interface of authentication providers.
authentication(Authentication) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the authentication provider to use in the Pulsar client instance.
authentication(String, String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the authentication provider to use in the Pulsar client instance.
authentication(String, Map<String, String>) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the authentication provider to use in the Pulsar client instance.
AuthenticationDataProvider - Interface in org.apache.pulsar.client.api
Interface for accessing data which are used in variety of authentication schemes on client side
AuthenticationException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.AuthenticationException
 
AuthenticationFactory - Class in org.apache.pulsar.client.api
 
AuthenticationFactory() - Constructor for class org.apache.pulsar.client.api.AuthenticationFactory
 
AuthenticationUtil - Class in org.apache.pulsar.client.api
 
AuthenticationUtil() - Constructor for class org.apache.pulsar.client.api.AuthenticationUtil
 
AuthorizationException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.AuthorizationException
 
AUTO() - Static method in interface org.apache.pulsar.client.api.Schema
Deprecated.
AUTO_CONSUME() - Static method in interface org.apache.pulsar.client.api.Schema
 
AUTO_PRODUCE_BYTES() - Static method in interface org.apache.pulsar.client.api.Schema
 
AVRO(Class<T>) - Static method in interface org.apache.pulsar.client.api.Schema
 

B

batchingMaxMessages(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set the maximum number of messages permitted in a batch.
batchingMaxPublishDelay(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set the time period within which the messages sent will be batched default: 1 ms if batch messages are enabled.
becameActive(Consumer<?>, int) - Method in interface org.apache.pulsar.client.api.ConsumerEventListener
Notified when the consumer group is changed, and the consumer becomes the active consumer.
becameInactive(Consumer<?>, int) - Method in interface org.apache.pulsar.client.api.ConsumerEventListener
Notified when the consumer group is changed, and the consumer is still inactive or becomes inactive.
beforeConsume(Consumer<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
This is called just before the message is returned by Consumer.receive(), MessageListener.received(Consumer, Message) or the CompletableFuture returned by Consumer.receiveAsync() completes.
beforeSend(Producer<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.ProducerInterceptor
This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before send the message to the brokers.
blockIfQueueFull(boolean) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set whether the Producer.send(T) and Producer.sendAsync(T) operations should block when the outgoing message queue is full.
BrokerMetadataException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.BrokerMetadataException
 
BrokerPersistenceException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.BrokerPersistenceException
 
build() - Method in interface org.apache.pulsar.client.api.ClientBuilder
 
build() - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Finalize the immutable message
builder() - Static method in interface org.apache.pulsar.client.api.PulsarClient
Get a new builder instance that can used to configure and build a PulsarClient instance.
BYTES - Static variable in interface org.apache.pulsar.client.api.Schema
Schema that doesn't perform any encoding on the message payloads.

C

ChecksumException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.ChecksumException
 
choosePartition(Message<?>) - Method in interface org.apache.pulsar.client.api.MessageRouter
Deprecated.
choosePartition(Message<?>, TopicMetadata) - Method in interface org.apache.pulsar.client.api.MessageRouter
Choose a partition based on msg and the topic metadata.
ClientBuilder - Interface in org.apache.pulsar.client.api
Builder interface that is used to construct a PulsarClient instance.
ClientConfiguration - Class in org.apache.pulsar.client.api
Deprecated.
Use PulsarClient.builder() to construct and configure a new PulsarClient instance
ClientConfiguration() - Constructor for class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
clone() - Method in interface org.apache.pulsar.client.api.ClientBuilder
Create a copy of the current client builder.
clone() - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Create a copy of the current consumer builder.
clone() - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Create a copy of the current ProducerBuilder.
clone() - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Create a copy of the current ReaderBuilder.
close() - Method in interface org.apache.pulsar.client.api.Consumer
Close the consumer and stop the broker to push more messages.
close() - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
Close the interceptor.
close() - Method in interface org.apache.pulsar.client.api.Producer
Close the producer and releases resources allocated.
close() - Method in interface org.apache.pulsar.client.api.ProducerInterceptor
Close the interceptor.
close() - Method in interface org.apache.pulsar.client.api.PulsarClient
Close the PulsarClient and release all the resources.
closeAsync() - Method in interface org.apache.pulsar.client.api.Consumer
Asynchronously close the consumer and stop the broker to push more messages
closeAsync() - Method in interface org.apache.pulsar.client.api.Producer
Close the producer and releases resources allocated.
closeAsync() - Method in interface org.apache.pulsar.client.api.PulsarClient
Asynchronously close the PulsarClient and release all the resources.
closeAsync() - Method in interface org.apache.pulsar.client.api.Reader
Asynchronously close the reader and stop the broker to push more messages
CompressionType - Enum in org.apache.pulsar.client.api
 
compressionType(CompressionType) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set the compression type for the producer.
configure(Map<String, String>) - Method in interface org.apache.pulsar.client.api.Authentication
Deprecated.
This method will be deleted on version 2.0, instead please use configure(String encodedAuthParamString) which is in EncodedAuthenticationParameterSupport for now and will be integrated into this interface.
configure(String) - Method in interface org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport
Plugins which use ":" and/or "," in a configuration parameter value need to implement this interface.
configureFromJsonString(String) - Static method in class org.apache.pulsar.client.api.AuthenticationUtil
 
configureFromPulsar1AuthParamString(String) - Static method in class org.apache.pulsar.client.api.AuthenticationUtil
 
ConnectException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.ConnectException
 
connectionsPerBroker(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Sets the max number of connection that the client library will open to a single broker.
connectionTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the duration of time to wait for a connection to a broker to be established.
Consumer<T> - Interface in org.apache.pulsar.client.api
An interface that abstracts behavior of Pulsar's consumer.
ConsumerBuilder<T> - Interface in org.apache.pulsar.client.api
ConsumerBuilder is used to configure and create instances of Consumer.
ConsumerBusyException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.ConsumerBusyException
 
ConsumerConfiguration - Class in org.apache.pulsar.client.api
Deprecated.
Use PulsarClient.newConsumer() to build and configure a Consumer instance
ConsumerConfiguration() - Constructor for class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
ConsumerCryptoFailureAction - Enum in org.apache.pulsar.client.api
 
consumerEventListener(ConsumerEventListener) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Sets a ConsumerEventListener for the consumer.
ConsumerEventListener - Interface in org.apache.pulsar.client.api
Listener on the consumer state changes.
ConsumerInterceptor<T> - Interface in org.apache.pulsar.client.api
A plugin interface that allows you to intercept (and possibly mutate) messages received by the consumer.
consumerName(String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Set the consumer name.
ConsumerStats - Interface in org.apache.pulsar.client.api
Consumer statistics recorded by client.
create(String, String) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
Create an instance of the Authentication-Plugin
create(String, Map<String, String>) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
Create an instance of the Authentication-Plugin
create(Schema<T>) - Static method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Create a new message builder instance.
create() - Static method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
 
create() - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Finalize the creation of the Producer instance.
create(String) - Static method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
use PulsarClient.builder() to construct a client instance
create(String, ClientConfiguration) - Static method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
use PulsarClient.builder() to construct a client instance
create() - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Finalize the creation of the Reader instance.
createAsync() - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Finalize the creation of the Producer instance in asynchronous mode.
createAsync() - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Finalize the creation of the Reader instance in asynchronous mode.
createProducer(String) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
use PulsarClient.newProducer() to build a new producer
createProducer(String, ProducerConfiguration) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
use PulsarClient.newProducer() to build a new producer
createProducerAsync(String) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
use PulsarClient.newProducer() to build a new producer
createProducerAsync(String, ProducerConfiguration) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
use PulsarClient.newProducer() to build a new producer
createReader(String, MessageId, ReaderConfiguration) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
Use PulsarClient.newReader() to build a new reader
createReaderAsync(String, MessageId, ReaderConfiguration) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
Use PulsarClient.newReader() to build a new reader
CryptoException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.CryptoException
 
cryptoFailureAction(ConsumerCryptoFailureAction) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Sets the ConsumerCryptoFailureAction to the value specified
cryptoFailureAction(ProducerCryptoFailureAction) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Sets the ProducerCryptoFailureAction to the value specified
cryptoFailureAction(ConsumerCryptoFailureAction) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Sets the ConsumerCryptoFailureAction to the value specified
cryptoKeyReader(CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
CryptoKeyReader - Interface in org.apache.pulsar.client.api
 
cryptoKeyReader(CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
cryptoKeyReader(CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.ReaderBuilder

D

deadLetterPolicy(DeadLetterPolicy) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Set dead letter policy for consumer By default some message will redelivery so many times possible, even to the extent that it can be never stop.
DeadLetterPolicy - Class in org.apache.pulsar.client.api
 
DeadLetterPolicy() - Constructor for class org.apache.pulsar.client.api.DeadLetterPolicy
 
decode(byte[]) - Method in interface org.apache.pulsar.client.api.Schema
Decode a byte array into an object using the schema definition and deserializer implementation
disableReplication() - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Disable replication for this message.
disableReplication() - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Disable replication for this message.

E

earliest - Static variable in interface org.apache.pulsar.client.api.MessageId
 
enableBatching(boolean) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Control whether automatic batching of messages is enabled for the producer.
enableTcpNoDelay(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Configure whether to use TCP no-delay flag on the connection, to disable Nagle algorithm.
enableTls(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Deprecated.
use "pulsar+ssl://" in serviceUrl to enable
enableTlsHostnameVerification(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
It allows to validate hostname verification when client connects to broker over tls.
encode(T) - Method in interface org.apache.pulsar.client.api.Schema
Encode an object representing the message content into a byte array.
EncodedAuthenticationParameterSupport - Interface in org.apache.pulsar.client.api
 
EncryptionKeyInfo - Class in org.apache.pulsar.client.api
 
EncryptionKeyInfo() - Constructor for class org.apache.pulsar.client.api.EncryptionKeyInfo
 
EncryptionKeyInfo(byte[], Map<String, String>) - Constructor for class org.apache.pulsar.client.api.EncryptionKeyInfo
 
eventTime(long) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Set the event time for a given message.

F

flush() - Method in interface org.apache.pulsar.client.api.Producer
Flush all the messages buffered in the client and wait until all messages have been successfully persisted.
flushAsync() - Method in interface org.apache.pulsar.client.api.Producer
Flush all the messages buffered in the client and wait until all messages have been successfully persisted.
fromByteArray(byte[]) - Static method in interface org.apache.pulsar.client.api.MessageId
De-serialize a message id from a byte array
fromByteArrayWithTopic(byte[], TopicName) - Static method in interface org.apache.pulsar.client.api.MessageId
 

G

getAckTimeoutMillis() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getAuthData() - Method in interface org.apache.pulsar.client.api.Authentication
 
getAuthentication() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
getAuthMethodName() - Method in interface org.apache.pulsar.client.api.Authentication
 
getBatchingEnabled() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Return the flag whether automatic message batching is enabled or not.
getBatchingMaxMessages() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getBatchingMaxPublishDelayMs() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getBlockIfQueueFull() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getCommandData() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
 
getCompressionType() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getConcurrentLookupRequest() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Get configured total allowed concurrent lookup-request.
getConfigurationData() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
getConfigurationData() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getConnectionsPerBroker() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
getConnectionTimeoutMs() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Get the duration of time for which the client will wait for a connection to a broker to be established before giving up.
getConsumerEventListener() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getConsumerName() - Method in interface org.apache.pulsar.client.api.Consumer
Get the name of consumer.
getConsumerName() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getCryptoFailureAction() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getCryptoFailureAction() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getCryptoFailureAction() - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
 
getCryptoKeyReader() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getCryptoKeyReader() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getCryptoKeyReader() - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
 
getData() - Method in interface org.apache.pulsar.client.api.Message
Get the content of the message
getEncryptionCtx() - Method in interface org.apache.pulsar.client.api.Message
EncryptionContext contains encryption and compression information in it using which application can decrypt consumed message with encrypted-payload.
getEncryptionKeys() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getEventTime() - Method in interface org.apache.pulsar.client.api.Message
Get the event time associated with this message.
getHashingScheme() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getHttpAuthType() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
 
getHttpHeaders() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
 
getInitialSequenceId() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getIoThreads() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
getKey() - Method in class org.apache.pulsar.client.api.EncryptionKeyInfo
 
getKey() - Method in interface org.apache.pulsar.client.api.Message
Get the key of the message
getKeyBytes() - Method in interface org.apache.pulsar.client.api.Message
Get bytes in key.
getLastSequenceId() - Method in interface org.apache.pulsar.client.api.Producer
Get the last sequence id that was published by this producer.
getListenerThreads() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
getMaxNumberOfRejectedRequestPerConnection() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Get configured max number of reject-request in a time-frame (30 seconds) after which connection will be closed
getMaxPendingMessages() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getMaxPendingMessagesAcrossPartitions() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getMaxTotalReceiverQueueSizeAcrossPartitions() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getMessageId() - Method in interface org.apache.pulsar.client.api.Message
Get the unique message ID associated with this message.
getMessageListener() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getMessageRouter(int) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
since 1.22.0-incubating. numPartitions is already passed as parameter in MessageRouter.choosePartition(Message, TopicMetadata).
getMessageRouter() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
getMessageRoutingMode() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Get the message routing mode for the partitioned producer.
getMetadata() - Method in class org.apache.pulsar.client.api.EncryptionKeyInfo
 
getNumAcksFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getNumAcksReceived() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getNumAcksSent() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getNumBytesReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getNumBytesSent() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getNumMsgsReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getNumMsgsSent() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getNumReceiveFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getNumSendFailed() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getOperationTimeoutMs() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
getPartitionsForTopic(String) - Method in interface org.apache.pulsar.client.api.PulsarClient
Get the list of partitions for a given topic.
getPriorityLevel() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getPrivateKey(String, Map<String, String>) - Method in interface org.apache.pulsar.client.api.CryptoKeyReader
 
getProducerConfigurationData() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getProducerName() - Method in interface org.apache.pulsar.client.api.Message
Get the producer name who produced this message.
getProducerName() - Method in interface org.apache.pulsar.client.api.Producer
 
getProducerName() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getProperties() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getProperties() - Method in interface org.apache.pulsar.client.api.Message
Return the properties attached to the message.
getProperties() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getProperty(String) - Method in interface org.apache.pulsar.client.api.Message
Get the value of a specific property
getPublicKey(String, Map<String, String>) - Method in interface org.apache.pulsar.client.api.CryptoKeyReader
Return the encryption key corresponding to the key name in the argument
getPublishTime() - Method in interface org.apache.pulsar.client.api.Message
Get the publish time of this message.
getRateBytesReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getRateMsgsReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getReadCompacted() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getReaderConfigurationData() - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
 
getReaderListener() - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
 
getReaderName() - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
 
getReceiverQueueSize() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getReceiverQueueSize() - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
 
getRedeliveryCount() - Method in interface org.apache.pulsar.client.api.Message
Get message redelivery count, redelivery count maintain in pulsar broker.
getSchema(SchemaInfo) - Static method in interface org.apache.pulsar.client.api.Schema
 
getSchemaInfo() - Method in interface org.apache.pulsar.client.api.Schema
 
getSendBytesRate() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getSendLatencyMillis50pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getSendLatencyMillis75pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getSendLatencyMillis95pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getSendLatencyMillis999pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getSendLatencyMillis99pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getSendLatencyMillisMax() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getSendMsgsRate() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getSendTimeoutMs() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
getSequenceId() - Method in interface org.apache.pulsar.client.api.Message
Get the sequence id associated with this message.
getServiceUrl() - Method in interface org.apache.pulsar.client.api.ServiceUrlProvider
Get the current service URL the Pulsar client should connect to.
getStats() - Method in interface org.apache.pulsar.client.api.Consumer
Get statistics for the consumer.
getStats() - Method in interface org.apache.pulsar.client.api.Producer
Get statistics for the producer numMsgsSent : Number of messages sent in the current interval numBytesSent : Number of bytes sent in the current interval numSendFailed : Number of messages failed to send in the current interval numAcksReceived : Number of acks received in the current interval totalMsgsSent : Total number of messages sent totalBytesSent : Total number of bytes sent totalSendFailed : Total number of messages failed to send totalAcksReceived: Total number of acks received
getStatsIntervalSeconds() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Stats will be activated with positive statsIntervalSeconds
getSubscription() - Method in interface org.apache.pulsar.client.api.Consumer
Get a subscription for the consumer
getSubscriptionInitialPosition() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getSubscriptionRolePrefix() - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
 
getSubscriptionType() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
getTickDurationMillis() - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
GettingAuthenticationDataException(Throwable) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.GettingAuthenticationDataException
 
GettingAuthenticationDataException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.GettingAuthenticationDataException
 
getTlsCertificates() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
 
getTlsPrivateKey() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
 
getTlsTrustCertsFilePath() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
getTopic() - Method in interface org.apache.pulsar.client.api.Consumer
Get a topic for the consumer
getTopic() - Method in interface org.apache.pulsar.client.api.Producer
 
getTopic() - Method in interface org.apache.pulsar.client.api.Reader
 
getTopicName() - Method in interface org.apache.pulsar.client.api.Message
Get the topic the message was published to
getTotalAcksFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getTotalAcksReceived() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getTotalAcksSent() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getTotalBytesReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getTotalBytesSent() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getTotalMsgsReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getTotalMsgsSent() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getTotalReceivedFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
 
getTotalSendFailed() - Method in interface org.apache.pulsar.client.api.ProducerStats
 
getValue() - Method in interface org.apache.pulsar.client.api.Message
 
getValue() - Method in enum org.apache.pulsar.client.api.SubscriptionInitialPosition
 

H

hasBase64EncodedKey() - Method in interface org.apache.pulsar.client.api.Message
Check whether the key has been base64 encoded.
hasDataForHttp() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
Check if data for HTTP are available.
hasDataForTls() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
Check if data for TLS are available.
hasDataFromCommand() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
Check if data from Pulsar protocol are available.
HashingScheme - Enum in org.apache.pulsar.client.api
Standard hashing functions available when choosing the partition to use for a particular message.
hashingScheme(HashingScheme) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Change the HashingScheme used to chose the partition on where to publish a particular message.
hasKey() - Method in interface org.apache.pulsar.client.api.Message
Check whether the message has a key
hasMessageAvailable() - Method in interface org.apache.pulsar.client.api.Reader
Check if there is any message available to read from the current position.
hasMessageAvailableAsync() - Method in interface org.apache.pulsar.client.api.Reader
Asynchronously Check if there is message that has been published successfully to the broker in the topic.
hasProperty(String) - Method in interface org.apache.pulsar.client.api.Message
Check whether the message has a specific property attached.
hasReachedEndOfTopic() - Method in interface org.apache.pulsar.client.api.Consumer
Return true if the topic was terminated and this consumer has already consumed all the messages in the topic.
hasReachedEndOfTopic() - Method in interface org.apache.pulsar.client.api.Reader
Return true if the topic was terminated and this reader has reached the end of the topic

I

initialize(PulsarClient) - Method in interface org.apache.pulsar.client.api.ServiceUrlProvider
Initialize the service url provider with Pulsar client instance.
initialSequenceId(long) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set the baseline for the sequence ids for messages published by the producer.
intercept(ConsumerInterceptor<T>...) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Intercept Consumer.
intercept(ProducerInterceptor<T>...) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Intercept Producer.
InvalidConfigurationException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException
 
InvalidConfigurationException(Throwable) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException
 
InvalidMessageException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.InvalidMessageException
 
InvalidServiceURL(Throwable) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.InvalidServiceURL
 
InvalidTopicNameException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.InvalidTopicNameException
 
ioThreads(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the number of threads to be used for handling connections to brokers (default: 1 thread)
isConnected() - Method in interface org.apache.pulsar.client.api.Consumer
 
isConnected() - Method in interface org.apache.pulsar.client.api.Producer
 
isConnected() - Method in interface org.apache.pulsar.client.api.Reader
 
isEncryptionEnabled() - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Returns true if encryption keys are added
isTlsAllowInsecureConnection() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
isTlsHostnameVerificationEnable() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
isUseTcpNoDelay() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
isUseTls() - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 

J

JSON(Class<T>) - Static method in interface org.apache.pulsar.client.api.Schema
 

K

keepAliveInterval(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set keep alive interval in seconds for each client-broker-connection.
key(String) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Sets the key of the message for routing policy
keyBytes(byte[]) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Sets the bytes of the key of the message for routing policy.
KeyValue(Class<K>, Class<V>, SchemaType) - Static method in interface org.apache.pulsar.client.api.Schema
Key Value Schema using passed in schema type, support JSON and AVRO currently.
KeyValue(Class<K>, Class<V>) - Static method in interface org.apache.pulsar.client.api.Schema
Key Value Schema whose underneath key and value schemas are JSONSchema.
KeyValue(Schema<K>, Schema<V>) - Static method in interface org.apache.pulsar.client.api.Schema
Key Value Schema using passed in key and value schemas.
KV_BYTES - Static variable in interface org.apache.pulsar.client.api.Schema
Schema that can be used to encode/decode KeyValue.

L

latest - Static variable in interface org.apache.pulsar.client.api.MessageId
 
listenerThreads(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the number of threads to be used for message listeners (default: 1 thread)
loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Load the configuration from provided config map.
loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Load the configuration from provided config map.
loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Load the configuration from provided config map.
loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Load the configuration from provided config map.
LookupException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.LookupException
 

M

maxConcurrentLookupRequests(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Number of concurrent lookup-requests allowed to send on each broker-connection to prevent overload on broker.
maxLookupRequests(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Number of max lookup-requests allowed on each broker-connection to prevent overload on broker.
maxNumberOfRejectedRequestPerConnection(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set max number of broker-rejected requests in a certain time-frame (30 seconds) after which current connection will be closed and client creates a new connection that give chance to connect a different broker (default: 50)
maxPendingMessages(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker.
maxPendingMessagesAcrossPartitions(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set the number of max pending messages across all the partitions
maxTotalReceiverQueueSizeAcrossPartitions(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Set the max total receiver queue size across partitons.
Message<T> - Interface in org.apache.pulsar.client.api
The message abstraction used in Pulsar.
MessageBuilder<T> - Interface in org.apache.pulsar.client.api
Deprecated.
since 2.0. Use TypedMessageBuilder as returned by Producer.newMessage() to create a new message builder.
MessageId - Interface in org.apache.pulsar.client.api
Opaque unique identifier of a single message The MessageId can be used to reference a specific message, for example when acknowledging, without having to retain the message content in memory for an extended period of time.
messageListener(MessageListener<T>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Sets a MessageListener for the consumer
MessageListener<T> - Interface in org.apache.pulsar.client.api
A listener that will be called in order for every message received.
MessageRouter - Interface in org.apache.pulsar.client.api
 
messageRouter(MessageRouter) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set a custom message routing policy by passing an implementation of MessageRouter
MessageRoutingMode - Enum in org.apache.pulsar.client.api
Default routing mode for messages to partition.
messageRoutingMode(MessageRoutingMode) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set the message routing mode for the partitioned producer.

N

newConsumer() - Method in interface org.apache.pulsar.client.api.PulsarClient
Create a consumer with default for subscribing on a specific topic
newConsumer(Schema<T>) - Method in interface org.apache.pulsar.client.api.PulsarClient
Create a consumer with default for subscribing on a specific topic Since 2.2, if you are creating a consumer with non-bytes schema on a non-existence topic, it will automatically create the topic with the provided schema.
newMessage() - Method in interface org.apache.pulsar.client.api.Producer
Create a new message builder This message builder allows to specify additional properties on the message.
newProducer() - Method in interface org.apache.pulsar.client.api.PulsarClient
Create a producer with default for publishing on a specific topic
newProducer(Schema<T>) - Method in interface org.apache.pulsar.client.api.PulsarClient
Create a producer with default for publishing on a specific topic
newReader() - Method in interface org.apache.pulsar.client.api.PulsarClient
Create a topic reader for reading messages from the specified topic.
newReader(Schema<T>) - Method in interface org.apache.pulsar.client.api.PulsarClient
Create a topic reader for reading messages from the specified topic.
NotConnectedException() - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.NotConnectedException
 
NotFoundException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.NotFoundException
 
NotFoundException(Throwable) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.NotFoundException
 
NotSupportedException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.NotSupportedException
 
numPartitions() - Method in interface org.apache.pulsar.client.api.TopicMetadata
Return the number of partitions per topic.

O

onAcknowledge(Consumer<T>, MessageId, Throwable) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
This is called consumer sends the acknowledgment to the broker.
onAcknowledgeCumulative(Consumer<T>, MessageId, Throwable) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
This is called consumer send the cumulative acknowledgment to the broker.
onSendAcknowledgement(Producer<T>, Message<T>, MessageId, Throwable) - Method in interface org.apache.pulsar.client.api.ProducerInterceptor
This method is called when the message sent to the broker has been acknowledged, or when sending the message fails.
operationTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the operation timeout (default: 30 seconds)
org.apache.pulsar.client.api - package org.apache.pulsar.client.api
 

P

patternAutoDiscoveryPeriod(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Set topics auto discovery period when using a pattern for topics consumer.
pause() - Method in interface org.apache.pulsar.client.api.Consumer
Stop requesting new messages from the broker until Consumer.resume() is called.
priorityLevel(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Sets priority level for the shared subscription consumers to which broker gives more priority while dispatching messages.
Producer<T> - Interface in org.apache.pulsar.client.api
Producer object.
ProducerBlockedQuotaExceededError(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededError
 
ProducerBlockedQuotaExceededException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededException
 
ProducerBuilder<T> - Interface in org.apache.pulsar.client.api
ProducerBuilder is used to configure and create instances of Producer.
ProducerBusyException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.ProducerBusyException
 
ProducerConfiguration - Class in org.apache.pulsar.client.api
Deprecated.
use PulsarClient.newProducer() to construct and configure a Producer instance
ProducerConfiguration() - Constructor for class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
ProducerConfiguration.HashingScheme - Enum in org.apache.pulsar.client.api
Deprecated.
ProducerConfiguration.MessageRoutingMode - Enum in org.apache.pulsar.client.api
Deprecated.
ProducerCryptoFailureAction - Enum in org.apache.pulsar.client.api
 
ProducerInterceptor<T> - Interface in org.apache.pulsar.client.api
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.
producerName(String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Specify a name for the producer
ProducerQueueIsFullError(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.ProducerQueueIsFullError
 
ProducerStats - Interface in org.apache.pulsar.client.api
Producer statistics recorded by client.
properties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Add all the properties in the provided map
properties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Add all the properties in the provided map
properties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Add all the properties in the provided map
property(String, String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Set a name/value property with this consumer.
property(String, String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set a name/value property with this producer.
property(String, String) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Sets a new property on a message.
PROTOBUF(Class<T>) - Static method in interface org.apache.pulsar.client.api.Schema
 
PulsarClient - Interface in org.apache.pulsar.client.api
Class that provides a client interface to Pulsar.
PulsarClientException - Exception in org.apache.pulsar.client.api
Base type of exception thrown by Pulsar client
PulsarClientException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException
 
PulsarClientException(Throwable) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException
 
PulsarClientException.AlreadyClosedException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.AuthenticationException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.AuthorizationException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.BrokerMetadataException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.BrokerPersistenceException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.ChecksumException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.ConnectException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.ConsumerBusyException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.CryptoException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.GettingAuthenticationDataException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.InvalidConfigurationException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.InvalidMessageException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.InvalidServiceURL - Exception in org.apache.pulsar.client.api
 
PulsarClientException.InvalidTopicNameException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.LookupException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.NotConnectedException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.NotFoundException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.NotSupportedException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.ProducerBlockedQuotaExceededError - Exception in org.apache.pulsar.client.api
 
PulsarClientException.ProducerBlockedQuotaExceededException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.ProducerBusyException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.ProducerQueueIsFullError - Exception in org.apache.pulsar.client.api
 
PulsarClientException.TimeoutException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.TooManyRequestsException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.TopicTerminatedException - Exception in org.apache.pulsar.client.api
 
PulsarClientException.UnsupportedAuthenticationException - Exception in org.apache.pulsar.client.api
 

R

reachedEndOfTopic(Consumer<T>) - Method in interface org.apache.pulsar.client.api.MessageListener
Get the notification when a topic is terminated
reachedEndOfTopic(Reader<T>) - Method in interface org.apache.pulsar.client.api.ReaderListener
Get the notification when a topic is terminated
readCompacted(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
If enabled, the consumer will read messages from the compacted topic rather than reading the full message backlog of the topic.
readCompacted(boolean) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
If enabled, the reader will read messages from the compacted topic rather than reading the full message backlog of the topic.
Reader<T> - Interface in org.apache.pulsar.client.api
A Reader can be used to scan through all the messages currently available in a topic.
ReaderBuilder<T> - Interface in org.apache.pulsar.client.api
ReaderBuilder is used to configure and create instances of Reader.
ReaderConfiguration - Class in org.apache.pulsar.client.api
Deprecated.
Use PulsarClient.newReader() to construct and configure a Reader instance
ReaderConfiguration() - Constructor for class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
 
readerListener(ReaderListener<T>) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Sets a ReaderListener for the reader
ReaderListener<T> - Interface in org.apache.pulsar.client.api
A listener that will be called in order for every message received.
readerName(String) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Set the reader name.
readNext() - Method in interface org.apache.pulsar.client.api.Reader
Read the next message in the topic
readNext(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.Reader
Read the next message in the topic waiting for a maximum of timeout time units.
readNextAsync() - Method in interface org.apache.pulsar.client.api.Reader
 
receive() - Method in interface org.apache.pulsar.client.api.Consumer
Receives a single message.
receive(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
Receive a single message
receiveAsync() - Method in interface org.apache.pulsar.client.api.Consumer
Receive a single message
received(Consumer<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.MessageListener
This method is called whenever a new message is received.
received(Reader<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.ReaderListener
This method is called whenever a new message is received.
receiverQueueSize(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Sets the size of the consumer receive queue.
receiverQueueSize(int) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Sets the size of the consumer receive queue.
redeliverUnacknowledgedMessages() - Method in interface org.apache.pulsar.client.api.Consumer
Redelivers all the unacknowledged messages.
removeEncryptionKey(String) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
replicationClusters(List<String>) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Override the replication clusters for this message.
resume() - Method in interface org.apache.pulsar.client.api.Consumer
Resume requesting messages from the broker.

S

Schema<T> - Interface in org.apache.pulsar.client.api
Message schema definition
SchemaSerializationException - Exception in org.apache.pulsar.client.api
 
SchemaSerializationException(String) - Constructor for exception org.apache.pulsar.client.api.SchemaSerializationException
 
SchemaSerializationException(Throwable) - Constructor for exception org.apache.pulsar.client.api.SchemaSerializationException
 
seek(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
Reset the subscription associated with this consumer to a specific message id.
seekAsync(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
Reset the subscription associated with this consumer to a specific message id.
send(T) - Method in interface org.apache.pulsar.client.api.Producer
Sends a message.
send(Message<T>) - Method in interface org.apache.pulsar.client.api.Producer
Deprecated.
since 2.0. Use TypedMessageBuilder as returned by Producer.newMessage() to create a new message builder.
send() - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Send a message synchronously.
sendAsync(T) - Method in interface org.apache.pulsar.client.api.Producer
Send a message asynchronously
sendAsync(Message<T>) - Method in interface org.apache.pulsar.client.api.Producer
Deprecated.
since 2.0. Use TypedMessageBuilder as returned by Producer.newMessage() to create a new message builder.
sendAsync() - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Send a message asynchronously
sendTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Set the send timeout (default: 30 seconds)
sequenceId(long) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Specify a custom sequence id for the message being published.
serviceUrl(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Configure the service URL for the Pulsar service.
serviceUrlProvider(ServiceUrlProvider) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Configure the service URL provider for Pulsar service
ServiceUrlProvider - Interface in org.apache.pulsar.client.api
The provider to provide the service url.
setAckTimeout(long, TimeUnit) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Set the timeout for unacked messages, truncated to the nearest millisecond.
setAuthentication(Authentication) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the authentication provider to use in the Pulsar client instance.
setAuthentication(String, String) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the authentication provider to use in the Pulsar client instance.
setAuthentication(String, Map<String, String>) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the authentication provider to use in the Pulsar client instance.
setBatchingEnabled(boolean) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Control whether automatic batching of messages is enabled for the producer.
setBatchingMaxMessages(int) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set the maximum number of messages permitted in a batch.
setBatchingMaxPublishDelay(long, TimeUnit) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set the time period within which the messages sent will be batched default: 10ms if batch messages are enabled.
setBlockIfQueueFull(boolean) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set whether the Producer.send(T) and Producer.sendAsync(T) operations should block when the outgoing message queue is full.
setCompressionType(CompressionType) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set the compression type for the producer.
setConcurrentLookupRequest(int) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Number of concurrent lookup-requests allowed on each broker-connection to prevent overload on broker.
setConnectionsPerBroker(int) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Sets the max number of connection that the client library will open to a single broker.
setConnectionTimeout(int, TimeUnit) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the duration of time to wait for a connection to a broker to be established.
setConsumerEventListener(ConsumerEventListener) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Sets a ConsumerEventListener for the consumer.
setConsumerName(String) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Set the consumer name.
setContent(byte[]) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Set the content of the message
setContent(byte[], int, int) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Set the content of the message
setContent(ByteBuffer) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Set the content of the message
setCryptoFailureAction(ConsumerCryptoFailureAction) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Sets the ConsumerCryptoFailureAction to the value specified
setCryptoFailureAction(ProducerCryptoFailureAction) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Sets the ProducerCryptoFailureAction to the value specified
setCryptoFailureAction(ConsumerCryptoFailureAction) - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
Sets the ConsumerCryptoFailureAction to the value specified
setCryptoKeyReader(CryptoKeyReader) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
setCryptoKeyReader(CryptoKeyReader) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
setCryptoKeyReader(CryptoKeyReader) - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
setEventTime(long) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Set the event time for a given message.
setHashingScheme(ProducerConfiguration.HashingScheme) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
 
setInitialSequenceId(long) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set the baseline for the sequence ids for messages published by the producer.
setIoThreads(int) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the number of threads to be used for handling connections to brokers (default: 1 thread)
setKey(byte[]) - Method in class org.apache.pulsar.client.api.EncryptionKeyInfo
 
setKey(String) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Sets the key of the message for routing policy
setListenerThreads(int) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the number of threads to be used for message listeners (default: 1 thread)
setMaxNumberOfRejectedRequestPerConnection(int) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set max number of broker-rejected requests in a certain time-frame (30 seconds) after which current connection will be closed and client creates a new connection that give chance to connect a different broker (default: 50)
setMaxPendingMessages(int) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker.
setMaxPendingMessagesAcrossPartitions(int) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set the number of max pending messages across all the partitions
setMaxTotalReceiverQueueSizeAcrossPartitions(int) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Set the max total receiver queue size across partitons.
setMessageListener(MessageListener<byte[]>) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Sets a MessageListener for the consumer
setMessageRouter(MessageRouter) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set a custom message routing policy by passing an implementation of MessageRouter
setMessageRoutingMode(ProducerConfiguration.MessageRoutingMode) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set the message routing mode for the partitioned producer.
setMetadata(Map<String, String>) - Method in class org.apache.pulsar.client.api.EncryptionKeyInfo
 
setOperationTimeout(int, TimeUnit) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the operation timeout (default: 30 seconds)
setPriorityLevel(int) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Sets priority level for the shared subscription consumers to which broker gives more priority while dispatching messages.
setProducerName(String) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Specify a name for the producer
setProperties(Map<String, String>) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Add all the properties in the provided map
setProperties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Add all the properties in the provided map
setProperties(Map<String, String>) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Add all the properties in the provided map
setProperty(String, String) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Set a name/value property with this consumer.
setProperty(String, String) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Sets a new property on a message.
setProperty(String, String) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set a name/value property with this producer.
setReadCompacted(boolean) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
If enabled, the consumer will read messages from the compacted topic rather than reading the full message backlog of the topic.
setReaderListener(ReaderListener<byte[]>) - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
Sets a ReaderListener for the reader
setReaderName(String) - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
Set the consumer name.
setReceiverQueueSize(int) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Sets the size of the consumer receive queue.
setReceiverQueueSize(int) - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
Sets the size of the consumer receive queue.
setReplicationClusters(List<String>) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Override the replication clusters for this message.
setSendTimeout(int, TimeUnit) - Method in class org.apache.pulsar.client.api.ProducerConfiguration
Deprecated.
Set the send timeout (default: 30 seconds)
setSequenceId(long) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Specify a custom sequence id for the message being published.
setServiceUrl(String) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
 
setStatsInterval(long, TimeUnit) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the interval between each stat info (default: 60 seconds) Stats will be activated with positive statsIntervalSeconds It should be set to at least 1 second
setSubscriptionInitialPosition(SubscriptionInitialPosition) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
 
setSubscriptionRolePrefix(String) - Method in class org.apache.pulsar.client.api.ReaderConfiguration
Deprecated.
Set the subscription role prefix for subscription auth.
setSubscriptionType(SubscriptionType) - Method in class org.apache.pulsar.client.api.ConsumerConfiguration
Deprecated.
Select the subscription type to be used when subscribing to the topic.
setTlsAllowInsecureConnection(boolean) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false)
setTlsHostnameVerificationEnable(boolean) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
It allows to validate hostname verification when client connects to broker over tls.
setTlsTrustCertsFilePath(String) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Set the path to the trusted TLS certificate file
setUseTcpNoDelay(boolean) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Configure whether to use TCP no-delay flag on the connection, to disable Nagle algorithm.
setUseTls(boolean) - Method in class org.apache.pulsar.client.api.ClientConfiguration
Deprecated.
Configure whether to use TLS encryption on the connection (default: false)
setValue(T) - Method in interface org.apache.pulsar.client.api.MessageBuilder
Deprecated.
Set a domain object on the message
shutdown() - Method in interface org.apache.pulsar.client.api.PulsarClient
Perform immediate shutdown of PulsarClient.
start() - Method in interface org.apache.pulsar.client.api.Authentication
Initialize the authentication provider
startMessageId(MessageId) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
The initial reader positioning is done by specifying a message id.
statsInterval(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the interval between each stat info (default: 60 seconds) Stats will be activated with positive statsIntervalSeconds It should be set to at least 1 second
STRING - Static variable in interface org.apache.pulsar.client.api.Schema
Schema that can be used to encode/decode messages whose values are String.
subscribe() - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Finalize the Consumer creation by subscribing to the topic.
subscribe(String, String) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
Use PulsarClient.newConsumer() to build a new consumer
subscribe(String, String, ConsumerConfiguration) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
Use PulsarClient.newConsumer() to build a new consumer
subscribeAsync() - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Finalize the Consumer creation by subscribing to the topic in asynchronous mode.
subscribeAsync(String, String) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
Use PulsarClient.newConsumer() to build a new consumer
subscribeAsync(String, String, ConsumerConfiguration) - Method in interface org.apache.pulsar.client.api.PulsarClient
Deprecated.
Use PulsarClient.newConsumer() to build a new consumer
subscriptionInitialPosition(SubscriptionInitialPosition) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Set subscriptionInitialPosition for the consumer
SubscriptionInitialPosition - Enum in org.apache.pulsar.client.api
intial position at which the cursor will be set when subscribe
subscriptionName(String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Specify the subscription name for this consumer.
subscriptionRolePrefix(String) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Set the subscription role prefix.
subscriptionTopicsMode(Mode) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both.
subscriptionType(SubscriptionType) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Select the subscription type to be used when subscribing to the topic.
SubscriptionType - Enum in org.apache.pulsar.client.api
Types of subscription supported by Pulsar

T

TimeoutException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.TimeoutException
 
TLS(String, String) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
Create an authentication provider for TLS based authentication.
tlsTrustCertsFilePath(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
Set the path to the trusted TLS certificate file
toByteArray() - Method in interface org.apache.pulsar.client.api.MessageId
Serialize the message ID into a byte array
token(String) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
Create an authentication provider for token based authentication.
token(Supplier<String>) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
Create an authentication provider for token based authentication.
TooManyRequestsException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.TooManyRequestsException
 
topic(String...) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Specify the topics this consumer will subscribe on.
topic(String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
Specify the topic this producer will be publishing on.
topic(String) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
Specify the topic this consumer will subscribe on.
TopicMetadata - Interface in org.apache.pulsar.client.api
Metadata of a topic that can be used for message routing.
topics(List<String>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Specify a list of topics that this consumer will subscribe on.
topicsPattern(Pattern) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Specify a pattern for topics that this consumer will subscribe on.
topicsPattern(String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
Specify a pattern for topics that this consumer will subscribe on.
TopicTerminatedException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.TopicTerminatedException
 
TypedMessageBuilder<T> - Interface in org.apache.pulsar.client.api
Message builder that constructs a message to be published through a producer.

U

unsubscribe() - Method in interface org.apache.pulsar.client.api.Consumer
Unsubscribe the consumer
unsubscribeAsync() - Method in interface org.apache.pulsar.client.api.Consumer
Asynchronously unsubscribe the consumer
UnsupportedAuthenticationException(Throwable) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException
 
UnsupportedAuthenticationException(String) - Constructor for exception org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException
 
updateServiceUrl(String) - Method in interface org.apache.pulsar.client.api.PulsarClient
Update the service URL this client is using.

V

validate(byte[]) - Method in interface org.apache.pulsar.client.api.Schema
Check if the message is a valid object for this schema.
value(T) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
Set a domain object on the message
valueOf(String) - Static method in enum org.apache.pulsar.client.api.CompressionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pulsar.client.api.ConsumerCryptoFailureAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pulsar.client.api.HashingScheme
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pulsar.client.api.MessageRoutingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pulsar.client.api.ProducerConfiguration.HashingScheme
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pulsar.client.api.ProducerConfiguration.MessageRoutingMode
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pulsar.client.api.ProducerCryptoFailureAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pulsar.client.api.SubscriptionInitialPosition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pulsar.client.api.SubscriptionType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.pulsar.client.api.CompressionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pulsar.client.api.ConsumerCryptoFailureAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pulsar.client.api.HashingScheme
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pulsar.client.api.MessageRoutingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pulsar.client.api.ProducerConfiguration.HashingScheme
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pulsar.client.api.ProducerConfiguration.MessageRoutingMode
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pulsar.client.api.ProducerCryptoFailureAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pulsar.client.api.SubscriptionInitialPosition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pulsar.client.api.SubscriptionType
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I J K L M N O P R S T U V 
Skip navigation links