SerializationSchema (Flink : 2.0-SNAPSHOT API)

Type Parameters:

T - The type to be serialized.

All Superinterfaces:

Serializable

All Known Implementing Classes:

AvroRowDataSerializationSchema, AvroRowSerializationSchema, AvroSerializationSchema, CanalJsonSerializationSchema, ConfluentRegistryAvroSerializationSchema, CsvRowDataSerializationSchema, CsvRowSerializationSchema, DebeziumAvroSerializationSchema, DebeziumJsonSerializationSchema, EventDeSerializationSchema, JsonRowDataSerializationSchema, JsonRowSerializationSchema, JsonSerializationSchema, MaxwellJsonSerializationSchema, OggJsonSerializationSchema, PbRowDataSerializationSchema, PythonConnectorUtils.SecondColumnSerializationSchema, RawFormatSerializationSchema, RegistryAvroSerializationSchema, SimpleStringSchema, TypeInformationSerializationSchema
```
@Public
public interface SerializationSchema<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).

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface SerializationSchema.InitializationContext
A contextual information provided for open(InitializationContext) method.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`open(SerializationSchema.InitializationContext context)`	Initialization method for the schema.
`byte[]`	`serialize(T element)`	Serializes the incoming element to a specified type.

- Method Detail
  - open
```
@PublicEvolving
default void open(SerializationSchema.InitializationContext context)
           throws Exception
```
    Initialization method for the schema. It is called before the actual working methods serialize(Object) and thus suitable for one time setup work.
    The provided SerializationSchema.InitializationContext can be used to access additional features such as e.g. registering user metrics.
    
    Parameters:
    
    context - Contextual information that can be used during initialization.
    
    Throws:
    
    Exception
  - serialize
```
byte[] serialize(T element)
```
    Serializes the incoming element to a specified type.
    
    Parameters:
    
    element - The incoming element to be serialized
    
    Returns:
    
    The serialized element.