org.apache.flink.state.api.output

Class FileCopyFunction

java.lang.Object

org.apache.flink.state.api.output.FileCopyFunction

All Implemented Interfaces:

Serializable, OutputFormat<Path>

@Internal
public final class FileCopyFunction
extends Object
implements OutputFormat<Path>

This output format copies files from an existing savepoint into a new directory.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.api.common.io.OutputFormat

OutputFormat.InitializationContext

Constructor Summary

Constructors

Constructor and Description
FileCopyFunction(String path)

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(Path sourcePath) Adds a record to the output.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.api.common.io.OutputFormat

open

Constructor Detail

FileCopyFunction

public FileCopyFunction(String path)

Parameters:

path - the destination path to copy file

Method Detail

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.

Specified by:

open in interface OutputFormat<Path>

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(Path sourcePath)
                 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.

Specified by:

writeRecord in interface OutputFormat<Path>

Parameters:

sourcePath - The records to add to the output.

Throws:

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

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.

Specified by:

configure in interface OutputFormat<Path>

Parameters:

parameters - The configuration with all parameters.

close

public void close()
           throws IOException

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.

Specified by:

close in interface OutputFormat<Path>

Throws:

IOException - Thrown, if the input could not be closed properly.