org.apache.flink.streaming.connectors.gcp.pubsub.common

Interface PubSubDeserializationSchema<T>

Type Parameters:

T - The type created by the deserialization schema.

All Superinterfaces:

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

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

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

Method Summary

Modifier and Type	Method and Description
T	deserialize(com.google.pubsub.v1.PubsubMessage message) Deserializes a PubsubMessage.
boolean	isEndOfStream(T nextElement) Method to decide whether the element signals the end of the stream.

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(com.google.pubsub.v1.PubsubMessage message)
       throws Exception

Deserializes a PubsubMessage.

Parameters:

message - PubsubMessage to be deserialized.

Returns:

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

Throws:

Exception