org.apache.pulsar.client.api

Interface Message<T>

All Known Implementing Classes:

MessageImpl, TopicMessageImpl

public interface Message<T>

The message abstraction used in Pulsar.

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Get the content of the message
Optional<EncryptionContext>	getEncryptionCtx() EncryptionContext contains encryption and compression information in it using which application can decrypt consumed message with encrypted-payload.
long	getEventTime() Get the event time associated with this message.
String	getKey() Get the key of the message
byte[]	getKeyBytes() Get bytes in key.
MessageId	getMessageId() Get the unique message ID associated with this message.
String	getProducerName() Get the producer name who produced this message.
Map<String,String>	getProperties() Return the properties attached to the message.
String	getProperty(String name) Get the value of a specific property
long	getPublishTime() Get the publish time of this message.
long	getSequenceId() Get the sequence id associated with this message.
String	getTopicName() Get the topic the message was published to
T	getValue()
boolean	hasBase64EncodedKey() Check whether the key has been base64 encoded.
boolean	hasKey() Check whether the message has a key
boolean	hasProperty(String name) Check whether the message has a specific property attached.

Method Detail

getProperties

Map<String,String> getProperties()

Return the properties attached to the message. Properties are application defined key/value pairs that will be attached to the message

Returns:

an unmodifiable view of the properties map

hasProperty

boolean hasProperty(String name)

Check whether the message has a specific property attached.

Parameters:

name - the name of the property to check

Returns:

true if the message has the specified property

getProperty

String getProperty(String name)

Get the value of a specific property

Parameters:

name - the name of the property

Returns:

the value of the property or null if the property was not defined

getData

byte[] getData()

Get the content of the message

Returns:

the byte array with the message payload

getValue

T getValue()

getMessageId

MessageId getMessageId()

Get the unique message ID associated with this message. The message id can be used to univocally refer to a message without having the keep the entire payload in memory. Only messages received from the consumer will have a message id assigned.

Returns:

the message id null if this message was not received by this client instance

getPublishTime

long getPublishTime()

Get the publish time of this message. The publish time is the timestamp that a client publish the message.

Returns:

publish time of this message.

See Also:

getEventTime()

getEventTime

long getEventTime()

Get the event time associated with this message. It is typically set by the applications via MessageBuilder.setEventTime(long).

If there isn't any event time associated with this event, it will return 0.

Since:

1.20.0

See Also:

MessageBuilder.setEventTime(long)

getSequenceId

long getSequenceId()

Get the sequence id associated with this message. It is typically set by the applications via MessageBuilder.setSequenceId(long).

Returns:

sequence id associated with this message.

Since:

1.22.0

See Also:

MessageBuilder.setEventTime(long)

getProducerName

String getProducerName()

Get the producer name who produced this message.

Returns:

producer name who produced this message, null if producer name is not set.

Since:

1.22.0

hasKey

boolean hasKey()

Check whether the message has a key

Returns:

true if the key was set while creating the message

getKey

String getKey()

Get the key of the message

Returns:

the key of the message

hasBase64EncodedKey

boolean hasBase64EncodedKey()

Check whether the key has been base64 encoded.

Returns:

true if the key is base64 encoded, false otherwise

getKeyBytes

byte[] getKeyBytes()

Get bytes in key. If the key has been base64 encoded, it is decoded before being returned. Otherwise, if the key is a plain string, this method returns the UTF_8 encoded bytes of the string.

Returns:

the key in byte[] form

getTopicName

String getTopicName()

Get the topic the message was published to

Returns:

the topic the message was published to

getEncryptionCtx

Optional<EncryptionContext> getEncryptionCtx()

EncryptionContext contains encryption and compression information in it using which application can decrypt consumed message with encrypted-payload.

Returns: