org.apache.flink.streaming.examples.kafka

Class KafkaEventSchema

java.lang.Object

org.apache.flink.streaming.examples.kafka.KafkaEventSchema

All Implemented Interfaces:

Serializable, DeserializationSchema<KafkaEvent>, SerializationSchema<KafkaEvent>, ResultTypeQueryable<KafkaEvent>

public class KafkaEventSchema
extends Object
implements DeserializationSchema<KafkaEvent>, SerializationSchema<KafkaEvent>

The serialization schema for the KafkaEvent type. This class defines how to transform a Kafka record's bytes to a KafkaEvent, and vice-versa.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KafkaEventSchema()

Method Summary

Modifier and Type	Method and Description
KafkaEvent	deserialize(byte[] message) Deserializes the byte message.
TypeInformation<KafkaEvent>	getProducedType() Gets the data type (as a TypeInformation) produced by this function or input format.
boolean	isEndOfStream(KafkaEvent nextElement) Method to decide whether the element signals the end of the stream.
byte[]	serialize(KafkaEvent event) Serializes the incoming element to a specified type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KafkaEventSchema

public KafkaEventSchema()

Method Detail

serialize

public byte[] serialize(KafkaEvent event)

Description copied from interface: SerializationSchema

Serializes the incoming element to a specified type.

Specified by:

serialize in interface SerializationSchema<KafkaEvent>

Parameters:

event - The incoming element to be serialized

Returns:

The serialized element.

deserialize

public KafkaEvent deserialize(byte[] message)
                       throws IOException

Description copied from interface: DeserializationSchema

Deserializes the byte message.

Specified by:

deserialize in interface DeserializationSchema<KafkaEvent>

Parameters:

message - The message, as a byte array.

Returns:

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

Throws:

IOException

isEndOfStream

public boolean isEndOfStream(KafkaEvent nextElement)

Description copied from interface: DeserializationSchema

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

Specified by:

isEndOfStream in interface DeserializationSchema<KafkaEvent>

Parameters:

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

Returns:

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

getProducedType

public TypeInformation<KafkaEvent> getProducedType()

Description copied from interface: ResultTypeQueryable

Gets the data type (as a TypeInformation) produced by this function or input format.

Specified by:

getProducedType in interface ResultTypeQueryable<KafkaEvent>

Returns:

The data type produced by this function or input format.