org.apache.flink.connector.pulsar.source

Interface MessageSerializer<T>

All Superinterfaces:

Serializable

public interface MessageSerializer<T>
extends Serializable

An interface for the deserialization of Pulsar messages.

Method Summary

Modifier and Type	Method and Description
default void	open(org.apache.flink.api.common.serialization.SerializationSchema.InitializationContext context) Initialization method for the schema.
void	serialize(T element, org.apache.pulsar.client.api.TypedMessageBuilder<byte[]> messageBuilder) Serializes the incoming element to a specified type.
static <V> MessageSerializer<V>	valueOnly(org.apache.flink.api.common.serialization.SerializationSchema<V> valueSerializer) Wraps a Flink SerializationSchema to a MessageSerializer.

Method Detail

serialize

void serialize(T element,
               org.apache.pulsar.client.api.TypedMessageBuilder<byte[]> messageBuilder)

Serializes the incoming element to a specified type.

Parameters:

element - The incoming element to be serialized

open

default void open(org.apache.flink.api.common.serialization.SerializationSchema.InitializationContext context)
           throws Exception

Initialization method for the schema. It is called before the actual working methods serialize(Object, TypedMessageBuilder) and thus suitable for one time setup work.

The provided SerializationSchema.InitializationContext can be used to access additional features such as e.g. registering user metrics.

Parameters:

context - Contextual information that can be used during initialization.

Throws:

Exception

valueOnly

static <V> MessageSerializer<V> valueOnly(org.apache.flink.api.common.serialization.SerializationSchema<V> valueSerializer)

Wraps a Flink SerializationSchema to a MessageSerializer.

Type Parameters:

V - the value type.

Parameters:

valueSerializer - the serializer class used to serialize the value.

Returns:

A MessageSerializer that deserialize the value with the given deserializer.