org.apache.flink.streaming.connectors.pulsar.internal

Interface PulsarDeserializationSchema<T>

Type Parameters:

T - The type created by the keyed deserialization schema.

All Superinterfaces:

org.apache.flink.api.java.typeutils.ResultTypeQueryable<T>, Serializable

All Known Implementing Classes:

DynamicPulsarDeserializationSchema, PulsarDeserializationSchemaWrapper, PulsarDeserializer, PulsarRowDeserializationSchema

@PublicEvolving
public interface PulsarDeserializationSchema<T>
extends Serializable, org.apache.flink.api.java.typeutils.ResultTypeQueryable<T>

The deserialization schema describes how to turn the pulsar messages into data types (Java/Scala objects) that are processed by Flink.

Method Summary

Modifier and Type	Method and Description
T	deserialize(org.apache.pulsar.client.api.Message message) Deserializes the Pulsar message.
default void	deserialize(org.apache.pulsar.client.api.Message message, org.apache.flink.util.Collector<T> out) Deserializes the Pulsar message.
boolean	isEndOfStream(T nextElement) Method to decide whether the element signals the end of the stream.
void	open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context)

Methods inherited from interface org.apache.flink.api.java.typeutils.ResultTypeQueryable

getProducedType

Method Detail

isEndOfStream

boolean isEndOfStream(T nextElement)

Method to decide whether the element signals the end of the stream. If true is returned the element won't be emitted.

Parameters:

nextElement - The element to test for the end-of-stream signal.

Returns:

True, if the element signals end of stream, false otherwise.

deserialize

T deserialize(org.apache.pulsar.client.api.Message message)
       throws IOException

Deserializes the Pulsar message.

Parameters:

message - Pulsar message to be deserialized.

Returns:

The deserialized message as an object (null if the message cannot be deserialized).

Throws:

IOException

deserialize

default void deserialize(org.apache.pulsar.client.api.Message message,
                         org.apache.flink.util.Collector<T> out)
                  throws Exception

Deserializes the Pulsar message.

Can output multiple records through the Collector. Note that number and size of the produced records should be relatively small. Depending on the source implementation records can be buffered in memory or collecting records might delay emitting checkpoint barrier.

Parameters:

message - The message, as a byte array.

out - The collector to put the resulting messages.

Throws:

Exception

open

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

Throws:

Exception