co.cask.cdap.messaging.store

Interface MessageTable.Entry

All Known Implementing Classes:

ImmutableMessageTableEntry

Enclosing interface:

MessageTable

public static interface MessageTable.Entry

Represents an entry (row) in the message table.

Method Summary

Modifier and Type	Method and Description
int	getGeneration() Returns the generation id of the topic.
byte[]	getPayload() Returns the message payload if isPayloadReference() return false; otherwise null will be returned.
long	getPublishTimestamp() Returns the timestamp in milliseconds when this entry was written to the message table.
short	getSequenceId() Returns the sequence id generated when this entry was written to the message table.
co.cask.cdap.proto.id.TopicId	getTopicId() Returns the topic id that the entry belongs to.
long	getTransactionWritePointer() Returns the transaction write pointer stored in this entry.
boolean	isPayloadReference() Returns true if the entry is a reference to messages stored in payload table.
boolean	isTransactional() Returns true if the message is a transactional message

Method Detail

getTopicId

co.cask.cdap.proto.id.TopicId getTopicId()

Returns the topic id that the entry belongs to.

getGeneration

int getGeneration()

Returns the generation id of the topic.

isPayloadReference

boolean isPayloadReference()

Returns true if the entry is a reference to messages stored in payload table.

isTransactional

boolean isTransactional()

Returns true if the message is a transactional message

getTransactionWritePointer

long getTransactionWritePointer()

Returns the transaction write pointer stored in this entry. The value returned will be valid if and only if isTransactional() returns true.

getPayload

@Nullable
byte[] getPayload()

Returns the message payload if isPayloadReference() return false; otherwise null will be returned.

getPublishTimestamp

long getPublishTimestamp()

Returns the timestamp in milliseconds when this entry was written to the message table.

getSequenceId

short getSequenceId()

Returns the sequence id generated when this entry was written to the message table.