org.apache.flink.streaming.util.serialization

Interface KeyedSerializationSchema<T>

Type Parameters:

T - The type to be serialized.

All Superinterfaces:

Serializable

All Known Implementing Classes:

KeyedSerializationSchemaWrapper, TypeInformationKeyValueSerializationSchema

@PublicEvolving
public interface KeyedSerializationSchema<T>
extends Serializable

The serialization schema describes how to turn a data object into a different serialized representation. Most data sinks (for example Apache Kafka) require the data to be handed to them in a specific format (for example as byte strings).

Method Summary

Modifier and Type	Method and Description
String	getTargetTopic(T element) Optional method to determine the target topic for the element.
byte[]	serializeKey(T element) Serializes the key of the incoming element to a byte array This method might return null if no key is available.
byte[]	serializeValue(T element) Serializes the value of the incoming element to a byte array.

Method Detail

serializeKey

byte[] serializeKey(T element)

Serializes the key of the incoming element to a byte array This method might return null if no key is available.

Parameters:

element - The incoming element to be serialized

Returns:

the key of the element as a byte array

serializeValue

byte[] serializeValue(T element)

Serializes the value of the incoming element to a byte array.

Parameters:

element - The incoming element to be serialized

Returns:

the value of the element as a byte array

getTargetTopic

String getTargetTopic(T element)

Optional method to determine the target topic for the element.

Parameters:

element - Incoming element to determine the target topic from

Returns:

null or the target topic