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

接口 PubSubDeserializationSchema<T>

类型参数:

T - The type created by the deserialization schema.

所有超级接口:

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.

方法概要

限定符和类型	方法和说明
T	deserialize(com.google.pubsub.v1.PubsubMessage message) Deserializes a PubsubMessage.
default void	deserialize(com.google.pubsub.v1.PubsubMessage message, org.apache.flink.util.Collector<T> out) Deserializes the PubSub record.
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) Initialization method for the schema.

从接口继承的方法 org.apache.flink.api.java.typeutils.ResultTypeQueryable

getProducedType

方法详细资料

open

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

Initialization method for the schema. It is called before the actual working methods deserialize(com.google.pubsub.v1.PubsubMessage) and thus suitable for one time setup work.

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

参数:

context - Contextual information that can be used during initialization.

抛出:

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.

参数:

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

返回:

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

deserialize

T deserialize(com.google.pubsub.v1.PubsubMessage message)
       throws Exception

Deserializes a PubsubMessage.

参数:

message - PubsubMessage to be deserialized.

返回:

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

抛出:

Exception

deserialize

default void deserialize(com.google.pubsub.v1.PubsubMessage message,
                         org.apache.flink.util.Collector<T> out)
                  throws Exception

Deserializes the PubSub record.

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.

参数:

message - PubsubMessage to be deserialized.

out - The collector to put the resulting messages.

抛出:

Exception