org.apache.flink.streaming.util.serialization

Interface PulsarDeserializationSchema<T>

Type Parameters:

T - The type created by the keyed deserialization schema.

All Superinterfaces:

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

All Known Implementing Classes:

PulsarDeserializationSchemaWrapper, PulsarDeserializer, PulsarPrimitiveSchema

@PublicEvolving
public interface PulsarDeserializationSchema<T>
extends PulsarContextAware<T>, Serializable

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
static <V> PulsarDeserializationSchemaBuilder<V>	builder() Deprecated.
T	deserialize(org.apache.pulsar.client.api.Message<T> message) Deserializes the Pulsar message.
default void	deserialize(org.apache.pulsar.client.api.Message<T> 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.
default void	open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context)
static <V> PulsarDeserializationSchema<V>	valueOnly(org.apache.flink.api.common.serialization.DeserializationSchema<V> valueDeserializer) Wraps a Flink DeserializationSchema to a PulsarDeserializationSchema.

Methods inherited from interface org.apache.flink.streaming.util.serialization.PulsarContextAware

getSchema, getTargetTopic, setNumParallelInstances, setParallelInstanceId

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

getProducedType

Method Detail

builder

@Deprecated
static <V> PulsarDeserializationSchemaBuilder<V> builder()

Deprecated.

valueOnly

static <V> PulsarDeserializationSchema<V> valueOnly(org.apache.flink.api.common.serialization.DeserializationSchema<V> valueDeserializer)

Wraps a Flink DeserializationSchema to a PulsarDeserializationSchema.

Type Parameters:

V - the value type.

Parameters:

valueDeserializer - the deserializer class used to deserialize the value.

Returns:

A PulsarDeserializationSchema that deserialize the value with the given deserializer.

open

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

Throws:

Exception

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<T> message)
       throws IOException

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.

Throws:

IOException

deserialize

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

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:

IOException