Package org.apache.flink.api.common.io

Interface Summary

Interface	Description
CheckpointableInputFormat<S extends InputSplit,T extends Serializable>	An interface that describes InputFormats that allow checkpointing/restoring their state.
CleanupWhenUnsuccessful	OutputFormats may implement this interface to run a cleanup hook when the execution is not successful.
FinalizeOnMaster	This interface may be implemented by OutputFormats to have the master finalize them globally.
FinalizeOnMaster.FinalizationContext	A context that provides parallelism and finished attempts infos.
InitializeOnMaster	This interface may be implemented by OutputFormats to have the master initialize them globally.
InputFormat<OT,T extends InputSplit>	The base interface for data sources that produces records.
NonParallelInput	This interface acts as a marker for input formats for inputs which cannot be split.
OutputFormat<IT>	The base interface for outputs that consumes records.
OutputFormat.InitializationContext	The context exposes some runtime info for initializing output format.

Class Summary

Class	Description
BinaryInputFormat<T>	Base class for all input formats that use blocks of fixed size.
BinaryOutputFormat<T>
BlockInfo	A block of 24 bytes written at the end of a block in a binary file, and containing i) the number of records in the block, ii) the accumulated number of records, and iii) the offset of the first record in the block.
DefaultInputSplitAssigner	This is the default implementation of the InputSplitAssigner interface.
DelimitedInputFormat<OT>	Base implementation for input formats that split the input at a delimiter into records.
FileInputFormat<OT>	The base class for RichInputFormats that read from files.
FileInputFormat.FileBaseStatistics	Encapsulation of the basic statistics the optimizer obtains about a file.
FileInputFormat.InputSplitOpenThread	Obtains a DataInputStream in an thread that is not interrupted.
FileOutputFormat<IT>	The abstract base class for all Rich output formats that are file based.
FilePathFilter	The FilePathFilter.filterPath(Path) method is responsible for deciding if a path is eligible for further processing or not.
FilePathFilter.DefaultFilter	The default file path filtering method and is used if no other such function is provided.
GenericCsvInputFormat<OT>
GenericInputFormat<OT>	Generic base class for all Rich inputs that are not based on files.
GlobFilePathFilter	Class for determining if a particular file should be included or excluded based on a set of include and exclude glob filters.
InputStreamFSInputWrapper	This class wraps an InputStream and exposes it as FSDataInputStream.
LocatableInputSplitAssigner	The locatable input split assigner assigns to each host splits that are local, before assigning splits that are not local.
OutputFormatBase<OUT,V>	OutputFormatBase is the common abstract class for output formats.
ReplicatingInputFormat<OT,S extends InputSplit>	A ReplicatingInputFormat replicates any InputFormat to all parallel instances of a DataSource, i.e., the full input of the replicated InputFormat is completely processed by each parallel instance of the DataSource.
ReplicatingInputSplitAssigner	Assigns each InputSplit to each requesting parallel instance.
RichInputFormat<OT,T extends InputSplit>	An abstract stub implementation for Rich input formats.
RichOutputFormat<IT>	An abstract stub implementation for Rich output formats.
SerializedInputFormat<T extends IOReadableWritable>	Reads elements by deserializing them with their regular serialization/deserialization functionality.
SerializedOutputFormat<T extends IOReadableWritable>	Stores elements by serializing them with their regular serialization/deserialization functionality.
SinkUtils	Utility class for sinks.

Enum Summary

Enum	Description
FileOutputFormat.OutputDirectoryMode	Behavior for creating output directories.

Exception Summary

Exception	Description
ParseException	Exception indicating that the parsing of input contents has failed because the data does not match the configured parser.