Package org.apache.flink.runtime.checkpoint.metadata

Class MetadataV3Serializer

java.lang.Object

org.apache.flink.runtime.checkpoint.metadata.MetadataV2V3SerializerBase

org.apache.flink.runtime.checkpoint.metadata.MetadataV3Serializer

All Implemented Interfaces:

Versioned, MetadataSerializer

Direct Known Subclasses:

MetadataV4Serializer

@Internal
public class MetadataV3Serializer
extends MetadataV2V3SerializerBase
implements MetadataSerializer

(De)serializer for checkpoint metadata format version 3. This format was introduced with Apache Flink 1.11.0.

Compared to format version 2, this drops some unused fields and introduces operator coordinator state.

See MetadataV2V3SerializerBase for a description of the format layout.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.checkpoint.metadata.MetadataV2V3SerializerBase

MetadataV2V3SerializerBase.DeserializationContext

Field Summary

Fields

Modifier and Type	Field	Description
static MetadataV3Serializer	INSTANCE	The singleton instance of the serializer.
static int	VERSION	The metadata format version.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataV3Serializer()	Singleton, not meant to be instantiated.

Method Summary

Modifier and Type	Method	Description
CheckpointMetadata	deserialize(DataInputStream dis, ClassLoader classLoader, String externalPointer)	Deserializes a savepoint from an input stream.
static StateObjectCollection<InputChannelStateHandle>	deserializeInputChannelStateHandle(DataInputStream dis)
StateObjectCollection<InputChannelStateHandle>	deserializeInputChannelStateHandle(DataInputStream dis, MetadataV2V3SerializerBase.DeserializationContext context)
static KeyedStateHandle	deserializeKeyedStateHandleUtil(DataInputStream dis)
protected OperatorState	deserializeOperatorState(DataInputStream dis, MetadataV2V3SerializerBase.DeserializationContext context)
static OperatorStateHandle	deserializeOperatorStateHandleUtil(DataInputStream dis)
StateObjectCollection<ResultSubpartitionStateHandle>	deserializeResultSubpartitionStateHandle(DataInputStream dis)
StateObjectCollection<ResultSubpartitionStateHandle>	deserializeResultSubpartitionStateHandle(DataInputStream dis, MetadataV2V3SerializerBase.DeserializationContext context)
static StreamStateHandle	deserializeStreamStateHandle(DataInputStream dis)
protected org.apache.flink.runtime.checkpoint.metadata.MetadataV3Serializer.SubtaskAndFinishedState	deserializeSubtaskIndexAndFinishedState(DataInputStream dis)
int	getVersion()	Returns the version number of the object.
void	serialize(CheckpointMetadata checkpointMetadata, DataOutputStream dos)	Serializes a savepoint or checkpoint metadata to an output stream.
void	serializeInputChannelStateHandle(InputChannelStateHandle handle, DataOutputStream dos)
static void	serializeKeyedStateHandleUtil(KeyedStateHandle stateHandle, DataOutputStream dos)
protected void	serializeOperatorState(OperatorState operatorState, DataOutputStream dos)
static void	serializeOperatorStateHandleUtil(OperatorStateHandle stateHandle, DataOutputStream dos)
void	serializeResultSubpartitionStateHandle(ResultSubpartitionStateHandle handle, DataOutputStream dos)
static void	serializeStreamStateHandle(StreamStateHandle stateHandle, DataOutputStream dos)
protected void	serializeSubtaskState(OperatorSubtaskState subtaskState, DataOutputStream dos)

Methods inherited from class org.apache.flink.runtime.checkpoint.metadata.MetadataV2V3SerializerBase

deserializeMasterState, deserializeMetadata, deserializeSubtaskState, serializeMasterState, serializeMetadata

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final int VERSION

The metadata format version.

See Also:

Constant Field Values

INSTANCE

public static final MetadataV3Serializer INSTANCE

The singleton instance of the serializer.

Constructor Detail

MetadataV3Serializer

protected MetadataV3Serializer()

Singleton, not meant to be instantiated.

Method Detail

getVersion

public int getVersion()

Description copied from interface: Versioned

Returns the version number of the object. Versions numbers can be used to differentiate evolving classes.

Specified by:

getVersion in interface Versioned

serialize

public void serialize(CheckpointMetadata checkpointMetadata,
                      DataOutputStream dos)
               throws IOException

Description copied from interface: MetadataSerializer

Serializes a savepoint or checkpoint metadata to an output stream.

Specified by:

serialize in interface MetadataSerializer

Throws:

IOException - Serialization failures are forwarded

deserialize

public CheckpointMetadata deserialize(DataInputStream dis,
                                      ClassLoader classLoader,
                                      String externalPointer)
                               throws IOException

Description copied from interface: MetadataSerializer

Deserializes a savepoint from an input stream.

Specified by:

deserialize in interface MetadataSerializer

Parameters:

dis - Input stream to deserialize savepoint from

classLoader - the user code class loader

externalPointer - the external pointer of the given checkpoint

Returns:

The deserialized savepoint

Throws:

IOException - Serialization failures are forwarded

serializeOperatorState

protected void serializeOperatorState(OperatorState operatorState,
                                      DataOutputStream dos)
                               throws IOException

Specified by:

serializeOperatorState in class MetadataV2V3SerializerBase

Throws:

IOException

serializeSubtaskState

protected void serializeSubtaskState(OperatorSubtaskState subtaskState,
                                     DataOutputStream dos)
                              throws IOException

Overrides:

serializeSubtaskState in class MetadataV2V3SerializerBase

Throws:

IOException

deserializeOperatorState

protected OperatorState deserializeOperatorState(DataInputStream dis,
                                                 @Nullable
                                                 MetadataV2V3SerializerBase.DeserializationContext context)
                                          throws IOException

Specified by:

deserializeOperatorState in class MetadataV2V3SerializerBase

Throws:

IOException

deserializeSubtaskIndexAndFinishedState

protected org.apache.flink.runtime.checkpoint.metadata.MetadataV3Serializer.SubtaskAndFinishedState deserializeSubtaskIndexAndFinishedState(DataInputStream dis)
                                                                                                                                     throws IOException

Throws:

IOException

serializeResultSubpartitionStateHandle

@VisibleForTesting
public void serializeResultSubpartitionStateHandle(ResultSubpartitionStateHandle handle,
                                                   DataOutputStream dos)
                                            throws IOException

Overrides:

serializeResultSubpartitionStateHandle in class MetadataV2V3SerializerBase

Throws:

IOException

deserializeResultSubpartitionStateHandle

@VisibleForTesting
public StateObjectCollection<ResultSubpartitionStateHandle> deserializeResultSubpartitionStateHandle(DataInputStream dis,
                                                                                                     @Nullable
                                                                                                     MetadataV2V3SerializerBase.DeserializationContext context)
                                                                                              throws IOException

Overrides:

deserializeResultSubpartitionStateHandle in class MetadataV2V3SerializerBase

Throws:

IOException

serializeInputChannelStateHandle

@VisibleForTesting
public void serializeInputChannelStateHandle(InputChannelStateHandle handle,
                                             DataOutputStream dos)
                                      throws IOException

Overrides:

serializeInputChannelStateHandle in class MetadataV2V3SerializerBase

Throws:

IOException

deserializeInputChannelStateHandle

@VisibleForTesting
public StateObjectCollection<InputChannelStateHandle> deserializeInputChannelStateHandle(DataInputStream dis,
                                                                                         @Nullable
                                                                                         MetadataV2V3SerializerBase.DeserializationContext context)
                                                                                  throws IOException

Overrides:

deserializeInputChannelStateHandle in class MetadataV2V3SerializerBase

Throws:

IOException

serializeStreamStateHandle

@VisibleForTesting
public static void serializeStreamStateHandle(StreamStateHandle stateHandle,
                                              DataOutputStream dos)
                                       throws IOException

Throws:

IOException

deserializeStreamStateHandle

@VisibleForTesting
public static StreamStateHandle deserializeStreamStateHandle(DataInputStream dis)
                                                      throws IOException

Throws:

IOException

serializeOperatorStateHandleUtil

@VisibleForTesting
public static void serializeOperatorStateHandleUtil(OperatorStateHandle stateHandle,
                                                    DataOutputStream dos)
                                             throws IOException

Throws:

IOException

deserializeOperatorStateHandleUtil

@VisibleForTesting
public static OperatorStateHandle deserializeOperatorStateHandleUtil(DataInputStream dis)
                                                              throws IOException

Throws:

IOException

serializeKeyedStateHandleUtil

@VisibleForTesting
public static void serializeKeyedStateHandleUtil(KeyedStateHandle stateHandle,
                                                 DataOutputStream dos)
                                          throws IOException

Throws:

IOException

deserializeKeyedStateHandleUtil

@VisibleForTesting
public static KeyedStateHandle deserializeKeyedStateHandleUtil(DataInputStream dis)
                                                        throws IOException

Throws:

IOException

deserializeInputChannelStateHandle

@VisibleForTesting
public static StateObjectCollection<InputChannelStateHandle> deserializeInputChannelStateHandle(DataInputStream dis)
                                                                                         throws IOException

Throws:

IOException

deserializeResultSubpartitionStateHandle

@VisibleForTesting
public StateObjectCollection<ResultSubpartitionStateHandle> deserializeResultSubpartitionStateHandle(DataInputStream dis)
                                                                                              throws IOException

Throws:

IOException