Package com.linkedin.venice.pubsub.api

Class PubSubMessageSerializer

java.lang.Object

com.linkedin.venice.pubsub.api.PubSubMessageSerializer

public class PubSubMessageSerializer
extends Object

A serializer for PubSub messages that converts KafkaKey and KafkaMessageEnvelope into byte arrays for transmission over PubSub systems.

Field Summary

Fields

Modifier and Type	Field	Description
static final PubSubMessageSerializer	DEFAULT_PUBSUB_SERIALIZER	A default instance of PubSubMessageSerializer using default KafkaKeySerializer and KafkaValueSerializer.

Constructor Summary

Constructors

Constructor	Description
PubSubMessageSerializer(VeniceKafkaSerializer<KafkaKey> keySerializer, VeniceKafkaSerializer<KafkaMessageEnvelope> valueSerializer)	Constructs a PubSubMessageSerializer with the specified key and value serializers.

Method Summary

Modifier and Type	Method	Description
byte[]	serializeKey(PubSubTopicPartition topicPartition, KafkaKey key)	Serializes a KafkaKey into a byte array.
byte[]	serializeKey(String topicName, KafkaKey key)
byte[]	serializeValue(PubSubTopicPartition topicPartition, KafkaMessageEnvelope value)	Serializes a KafkaMessageEnvelope into a byte array.
byte[]	serializeValue(String topicName, KafkaMessageEnvelope value)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PUBSUB_SERIALIZER

public static final PubSubMessageSerializer DEFAULT_PUBSUB_SERIALIZER

A default instance of PubSubMessageSerializer using default KafkaKeySerializer and KafkaValueSerializer.

Constructor Details

PubSubMessageSerializer

public PubSubMessageSerializer(VeniceKafkaSerializer<KafkaKey> keySerializer,
 VeniceKafkaSerializer<KafkaMessageEnvelope> valueSerializer)

Constructs a PubSubMessageSerializer with the specified key and value serializers.

Parameters:

keySerializer - The serializer for KafkaKey.

valueSerializer - The serializer for KafkaMessageEnvelope.

Method Details

serializeKey

public byte[] serializeKey(PubSubTopicPartition topicPartition,
 KafkaKey key)

Serializes a KafkaKey into a byte array.

Parameters:

topicPartition - The PubSubTopicPartition that the key belongs to.

key - The KafkaKey to be serialized.

Returns:

The serialized byte array representation of the key.

serializeKey

public byte[] serializeKey(String topicName,
 KafkaKey key)

serializeValue

public byte[] serializeValue(PubSubTopicPartition topicPartition,
 KafkaMessageEnvelope value)

Serializes a KafkaMessageEnvelope into a byte array.

Parameters:

topicPartition - The PubSubTopicPartition that the value belongs to.

value - The KafkaMessageEnvelope to be serialized.

Returns:

The serialized byte array representation of the value.

serializeValue

public byte[] serializeValue(String topicName,
 KafkaMessageEnvelope value)