Package com.linkedin.venice.pubsub

Class ImmutablePubSubMessage

java.lang.Object

com.linkedin.venice.pubsub.ImmutablePubSubMessage

All Implemented Interfaces:

Measurable, DefaultPubSubMessage, PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

public class ImmutablePubSubMessage
extends Object
implements DefaultPubSubMessage

Constructor Summary

Constructors

Constructor	Description
ImmutablePubSubMessage(KafkaKey key, KafkaMessageEnvelope value, PubSubTopicPartition topicPartition, PubSubPosition pubSubPosition, long timestamp, int payloadSize)
ImmutablePubSubMessage(KafkaKey key, KafkaMessageEnvelope value, PubSubTopicPartition topicPartition, PubSubPosition pubSubPosition, long timestamp, int payloadSize, PubSubMessageHeaders pubSubMessageHeaders)
ImmutablePubSubMessage(KafkaKey key, KafkaMessageEnvelope value, PubSubTopicPartition topicPartition, PubSubPosition pubSubPosition, long timestamp, int payloadSize, PubSubMessageHeaders pubSubMessageHeaders, int writerSchemaId, ByteBuffer replicationMetadataPayload)

Method Summary

Modifier and Type	Method	Description
int	getHeapSize()
KafkaKey	getKey()	Retrieves the key associated with this message.
int	getPayloadSize()
PubSubPosition	getPosition()	Retrieves the position of this message within the underlying topic-partition.
PubSubMessageHeaders	getPubSubMessageHeaders()
long	getPubSubMessageTime()
ByteBuffer	getReplicationMetadataPayload()
PubSubTopicPartition	getTopicPartition()
KafkaMessageEnvelope	getValue()	Retrieves the value payload of this message.
int	getWriterSchemaId()
boolean	isEndOfBootstrap()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linkedin.venice.pubsub.api.PubSubMessage

getOffset, getPartition, getTopic, getTopicName

Constructor Details

ImmutablePubSubMessage

public ImmutablePubSubMessage(KafkaKey key,
 KafkaMessageEnvelope value,
 PubSubTopicPartition topicPartition,
 PubSubPosition pubSubPosition,
 long timestamp,
 int payloadSize)

ImmutablePubSubMessage

public ImmutablePubSubMessage(KafkaKey key,
 KafkaMessageEnvelope value,
 PubSubTopicPartition topicPartition,
 PubSubPosition pubSubPosition,
 long timestamp,
 int payloadSize,
 PubSubMessageHeaders pubSubMessageHeaders)

ImmutablePubSubMessage

public ImmutablePubSubMessage(KafkaKey key,
 KafkaMessageEnvelope value,
 PubSubTopicPartition topicPartition,
 PubSubPosition pubSubPosition,
 long timestamp,
 int payloadSize,
 PubSubMessageHeaders pubSubMessageHeaders,
 int writerSchemaId,
 ByteBuffer replicationMetadataPayload)

Method Details

getKey

public KafkaKey getKey()

Description copied from interface: DefaultPubSubMessage

Retrieves the key associated with this message.

Specified by:

getKey in interface DefaultPubSubMessage

Specified by:

getKey in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

the KafkaKey representing the message key.

getValue

public KafkaMessageEnvelope getValue()

Description copied from interface: DefaultPubSubMessage

Retrieves the value payload of this message.

Specified by:

getValue in interface DefaultPubSubMessage

Specified by:

getValue in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

the KafkaMessageEnvelope containing the message data.

getTopicPartition

public PubSubTopicPartition getTopicPartition()

Specified by:

getTopicPartition in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

the topic-partition this message belongs to

getPosition

public PubSubPosition getPosition()

Description copied from interface: DefaultPubSubMessage

Retrieves the position of this message within the underlying topic-partition.

Specified by:

getPosition in interface DefaultPubSubMessage

Specified by:

getPosition in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

the PubSubPosition representing the message offset.

getPubSubMessageTime

public long getPubSubMessageTime()

Specified by:

getPubSubMessageTime in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

the timestamp at which the message was persisted in the pub sub system

getPayloadSize

public int getPayloadSize()

Specified by:

getPayloadSize in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

the size in bytes of the key + value.

isEndOfBootstrap

public boolean isEndOfBootstrap()

Specified by:

isEndOfBootstrap in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

whether this message marks the end of bootstrap.

getPubSubMessageHeaders

public PubSubMessageHeaders getPubSubMessageHeaders()

Specified by:

getPubSubMessageHeaders in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

getWriterSchemaId

public int getWriterSchemaId()

Specified by:

getWriterSchemaId in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

the schema id that the record was written with

getReplicationMetadataPayload

public ByteBuffer getReplicationMetadataPayload()

Specified by:

getReplicationMetadataPayload in interface PubSubMessage<KafkaKey,KafkaMessageEnvelope,PubSubPosition>

Returns:

The serialized value of the replication metadata payload.

toString

public String toString()

Overrides:

toString in class Object

getHeapSize

public int getHeapSize()

Specified by:

getHeapSize in interface Measurable