org.apache.flink.state.api.output

Class SavepointOutputFormat

java.lang.Object

org.apache.flink.api.common.io.RichOutputFormat<CheckpointMetadata>

org.apache.flink.state.api.output.SavepointOutputFormat

All Implemented Interfaces:

Serializable, OutputFormat<CheckpointMetadata>

@Internal
public class SavepointOutputFormat
extends RichOutputFormat<CheckpointMetadata>

An output format to serialize CheckpointMetadata metadata to distributed storage.

This format may only be executed with parallelism 1.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SavepointOutputFormat(Path savepointPath)

Method Summary

Modifier and Type	Method and Description
void	close() Method that marks the end of the life-cycle of parallel output instance.
void	configure(Configuration parameters) Configures this output format.
void	open(int taskNumber, int numTasks) Opens a parallel instance of the output format to store the result of its parallel instance.
void	writeRecord(CheckpointMetadata metadata) Adds a record to the output.

Methods inherited from class org.apache.flink.api.common.io.RichOutputFormat

getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

SavepointOutputFormat

public SavepointOutputFormat(Path savepointPath)

Method Detail

configure

public void configure(Configuration parameters)

Description copied from interface: OutputFormat

Configures this output format. Since output formats are instantiated generically and hence parameterless, this method is the place where the output formats set their basic fields based on configuration values.

This method is always called first on a newly instantiated output format.

Parameters:

parameters - The configuration with all parameters.

open

public void open(int taskNumber,
                 int numTasks)
          throws IOException

Description copied from interface: OutputFormat

Opens a parallel instance of the output format to store the result of its parallel instance.

When this method is called, the output format it guaranteed to be configured.

Parameters:

taskNumber - The number of the parallel instance.

numTasks - The number of parallel tasks.

Throws:

IOException - Thrown, if the output could not be opened due to an I/O problem.

writeRecord

public void writeRecord(CheckpointMetadata metadata)
                 throws IOException

Description copied from interface: OutputFormat

Adds a record to the output.

When this method is called, the output format it guaranteed to be opened.

Parameters:

metadata - The records to add to the output.

Throws:

IOException - Thrown, if the records could not be added to to an I/O problem.

close

public void close()

Description copied from interface: OutputFormat

Method that marks the end of the life-cycle of parallel output instance. Should be used to close channels and streams and release resources. After this method returns without an error, the output is assumed to be correct.

When this method is called, the output format it guaranteed to be opened.