PubSubMessage (venice API)

All Superinterfaces:: Measurable

All Known Subinterfaces:: DefaultPubSubMessage

All Known Implementing Classes:: ImmutableChangeCapturePubSubMessage, ImmutablePubSubMessage, PubSubHelper.MutableDefaultPubSubMessage

public interface PubSubMessage<K,V,POSITION> extends Measurable

Method Summary

Modifier and Type

Method

Description

K

getKey()

default POSITION

getOffset()

default int

getPartition()

int

getPayloadSize()

POSITION

getPosition()

default PubSubMessageHeaders

getPubSubMessageHeaders()

long

getPubSubMessageTime()

default PubSubTopic

getTopic()

default String

getTopicName()

PubSubTopicPartition

getTopicPartition()

V

getValue()

boolean

isEndOfBootstrap()

Methods inherited from interface com.linkedin.venice.memory.Measurable
getHeapSize

Method Details
- getKey
  
  K getKey()
  
  Returns:
  
  the key part of this message
- getValue
  
  V getValue()
  
  Returns:
  
  the value part of this message
- getTopicPartition
  
  PubSubTopicPartition getTopicPartition()
  
  Returns:
  
  the topic-partition this message belongs to
- getOffset
  
  default POSITION getOffset()
  
  Returns:
  
  the offset of this message in the underlying topic-partition
- getPosition
  
  POSITION getPosition()
- getPubSubMessageTime
  
  long getPubSubMessageTime()
  
  Returns:
  
  the best-available message timestamp. This is the pub-sub system timestamp when available and non-zero, otherwise the Venice producer timestamp embedded in the message envelope.
- getPayloadSize
  
  int getPayloadSize()
  
  Returns:
  
  the size in bytes of the key + value.
- getTopicName
  
  default String getTopicName()
- getTopic
  
  default PubSubTopic getTopic()
- getPartition
  
  default int getPartition()
- isEndOfBootstrap
  
  boolean isEndOfBootstrap()
  
  Returns:
  
  whether this message marks the end of bootstrap.
- getPubSubMessageHeaders
  
  default PubSubMessageHeaders getPubSubMessageHeaders()