org.apache.flink.api.common.typeutils

Class CompatibilityResult<T>

java.lang.Object

org.apache.flink.api.common.typeutils.CompatibilityResult<T>

Type Parameters:

T - the type of the data being migrated.

@PublicEvolving
public final class CompatibilityResult<T>
extends Object

A CompatibilityResult contains information about whether or not data migration is required in order to continue using new serializers for previously serialized data.

Method Summary

Modifier and Type	Method and Description
static <T> CompatibilityResult<T>	compatible() Returns a result that signals that the new serializer is compatible and no migration is required.
TypeDeserializer<T>	getConvertDeserializer()
boolean	isRequiresMigration()
static <T> CompatibilityResult<T>	requiresMigration() Returns a result that signals migration to be performed.
static <T> CompatibilityResult<T>	requiresMigration(TypeDeserializer<T> convertDeserializer) Returns a result that signals migration to be performed, and in the case that the preceding serializer cannot be found or restored to read the previous data during migration, a provided convert deserializer can be used.
static <T> CompatibilityResult<T>	requiresMigration(TypeSerializer<T> convertSerializer) Returns a result that signals migration to be performed, and in the case that the preceding serializer cannot be found or restored to read the previous data during migration, a provided convert serializer can be used.

Methods inherited from class java.lang.Object

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

Method Detail

compatible

public static <T> CompatibilityResult<T> compatible()

Returns a result that signals that the new serializer is compatible and no migration is required.

Returns:

a result that signals migration is not required for the new serializer

requiresMigration

public static <T> CompatibilityResult<T> requiresMigration(@Nonnull
                                                           TypeDeserializer<T> convertDeserializer)

Returns a result that signals migration to be performed, and in the case that the preceding serializer cannot be found or restored to read the previous data during migration, a provided convert deserializer can be used.

Type Parameters:

T - the type of the data being migrated.

Parameters:

convertDeserializer - the convert deserializer to use, in the case that the preceding serializer cannot be found.

Returns:

a result that signals migration is necessary, also providing a convert deserializer.

requiresMigration

public static <T> CompatibilityResult<T> requiresMigration(@Nonnull
                                                           TypeSerializer<T> convertSerializer)

Returns a result that signals migration to be performed, and in the case that the preceding serializer cannot be found or restored to read the previous data during migration, a provided convert serializer can be used. The provided serializer will only be used for deserialization.

Type Parameters:

T - the type of the data being migrated.

Parameters:

convertSerializer - the convert serializer to use, in the case that the preceding serializer cannot be found. The provided serializer will only be used for deserialization.

Returns:

a result that signals migration is necessary, also providing a convert serializer.

requiresMigration

public static <T> CompatibilityResult<T> requiresMigration()

Returns a result that signals migration to be performed. The migration will fail if the preceding serializer for the previous data cannot be found.

You can also provide a convert deserializer using requiresMigration(TypeDeserializer) or requiresMigration(TypeSerializer), which will be used as a fallback resort in such cases.

Returns:

a result that signals migration is necessary, without providing a convert deserializer.

getConvertDeserializer

public TypeDeserializer<T> getConvertDeserializer()

isRequiresMigration

public boolean isRequiresMigration()