Package org.apache.pulsar.reactive.client.api

Class ImmutableReactiveMessageReaderSpec

java.lang.Object

org.apache.pulsar.reactive.client.api.ImmutableReactiveMessageReaderSpec

All Implemented Interfaces:

ReactiveMessageReaderSpec

public class ImmutableReactiveMessageReaderSpec
extends Object
implements ReactiveMessageReaderSpec

Immutable spec for a ReactiveMessageReader.

Constructor Summary

Constructors

Constructor	Description
ImmutableReactiveMessageReaderSpec(List<String> topicNames, String readerName, String subscriptionName, String generatedSubscriptionNamePrefix, Integer receiverQueueSize, Boolean readCompacted, List<org.apache.pulsar.client.api.Range> keyHashRanges, org.apache.pulsar.client.api.CryptoKeyReader cryptoKeyReader, org.apache.pulsar.client.api.ConsumerCryptoFailureAction cryptoFailureAction)
ImmutableReactiveMessageReaderSpec(ReactiveMessageReaderSpec readerSpec)	Constructs a ImmutableReactiveMessageConsumerSpec from another ReactiveMessageConsumerSpec.

Method Summary

Modifier and Type	Method	Description
org.apache.pulsar.client.api.ConsumerCryptoFailureAction	getCryptoFailureAction()	Gets the action the reader will take in case of decryption failures.
org.apache.pulsar.client.api.CryptoKeyReader	getCryptoKeyReader()	Gets the key reader to be used to decrypt the message payloads.
String	getGeneratedSubscriptionNamePrefix()	Gets the generated subscription name prefix.
List<org.apache.pulsar.client.api.Range>	getKeyHashRanges()	Gets the key hash ranges of the reader.
Boolean	getReadCompacted()	Gets whether to read messages from the compacted topic rather than reading the full message backlog of the topic.
String	getReaderName()	Gets the reader name.
Integer	getReceiverQueueSize()	Gets the size of the reader receive queue.
String	getSubscriptionName()	Gets the subscription name.
List<String>	getTopicNames()	Gets the topics to read from.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ImmutableReactiveMessageReaderSpec

public ImmutableReactiveMessageReaderSpec(List<String> topicNames,
 String readerName,
 String subscriptionName,
 String generatedSubscriptionNamePrefix,
 Integer receiverQueueSize,
 Boolean readCompacted,
 List<org.apache.pulsar.client.api.Range> keyHashRanges,
 org.apache.pulsar.client.api.CryptoKeyReader cryptoKeyReader,
 org.apache.pulsar.client.api.ConsumerCryptoFailureAction cryptoFailureAction)

ImmutableReactiveMessageReaderSpec

public ImmutableReactiveMessageReaderSpec(ReactiveMessageReaderSpec readerSpec)

Constructs a ImmutableReactiveMessageConsumerSpec from another ReactiveMessageConsumerSpec.

Parameters:

readerSpec - the spec to construct from

Method Details

getTopicNames

public List<String> getTopicNames()

Description copied from interface: ReactiveMessageReaderSpec

Gets the topics to read from.

Specified by:

getTopicNames in interface ReactiveMessageReaderSpec

Returns:

the topic names

See Also:

• ReaderBuilder.topics(List)

getReaderName

public String getReaderName()

Description copied from interface: ReactiveMessageReaderSpec

Gets the reader name.

Specified by:

getReaderName in interface ReactiveMessageReaderSpec

Returns:

the reader name

See Also:

• ReaderBuilder.readerName(String)

getSubscriptionName

public String getSubscriptionName()

Description copied from interface: ReactiveMessageReaderSpec

Gets the subscription name.

Specified by:

getSubscriptionName in interface ReactiveMessageReaderSpec

Returns:

the name of the subscription

See Also:

• ReaderBuilder.subscriptionName(String)

getGeneratedSubscriptionNamePrefix

public String getGeneratedSubscriptionNamePrefix()

Description copied from interface: ReactiveMessageReaderSpec

Gets the generated subscription name prefix. The default prefix is "reader".

Specified by:

getGeneratedSubscriptionNamePrefix in interface ReactiveMessageReaderSpec

Returns:

the generated subscription name prefix

See Also:

• ReaderBuilder.subscriptionRolePrefix(String)

getReceiverQueueSize

public Integer getReceiverQueueSize()

Description copied from interface: ReactiveMessageReaderSpec

Gets the size of the reader receive queue.

Specified by:

getReceiverQueueSize in interface ReactiveMessageReaderSpec

Returns:

the size of the reader receive queue

See Also:

• ReaderBuilder.receiverQueueSize(int)

getReadCompacted

public Boolean getReadCompacted()

Description copied from interface: ReactiveMessageReaderSpec

Gets whether to read messages from the compacted topic rather than reading the full message backlog of the topic.

Specified by:

getReadCompacted in interface ReactiveMessageReaderSpec

Returns:

true if messages are read from the compacted topic

See Also:

• ReaderBuilder.readCompacted(boolean)

getKeyHashRanges

public List<org.apache.pulsar.client.api.Range> getKeyHashRanges()

Description copied from interface: ReactiveMessageReaderSpec

Gets the key hash ranges of the reader.

Specified by:

getKeyHashRanges in interface ReactiveMessageReaderSpec

Returns:

the key hash ranges

See Also:

• ReaderBuilder.keyHashRange(Range...)

getCryptoKeyReader

public org.apache.pulsar.client.api.CryptoKeyReader getCryptoKeyReader()

Description copied from interface: ReactiveMessageReaderSpec

Gets the key reader to be used to decrypt the message payloads.

Specified by:

getCryptoKeyReader in interface ReactiveMessageReaderSpec

Returns:

the key reader to be used to decrypt the message payloads

See Also:

• ReaderBuilder.cryptoKeyReader(org.apache.pulsar.client.api.CryptoKeyReader)

getCryptoFailureAction

public org.apache.pulsar.client.api.ConsumerCryptoFailureAction getCryptoFailureAction()

Description copied from interface: ReactiveMessageReaderSpec

Gets the action the reader will take in case of decryption failures.

Specified by:

getCryptoFailureAction in interface ReactiveMessageReaderSpec

Returns:

the action the reader will take in case of decryption failures

See Also:

• ReaderBuilder.cryptoFailureAction(org.apache.pulsar.client.api.ConsumerCryptoFailureAction)