org.apache.flink.core.io

Interface InputSplitSource<T extends InputSplit>

Type Parameters:

T - The type of the input splits created by the source.

All Superinterfaces:

Serializable

All Known Subinterfaces:

InputFormat<OT,T>

All Known Implementing Classes:

BinaryInputFormat, DelimitedInputFormat, FileInputFormat, GenericCsvInputFormat, GenericInputFormat, ReplicatingInputFormat, RichInputFormat, SerializedInputFormat

@Public
public interface InputSplitSource<T extends InputSplit>
extends Serializable

InputSplitSources create InputSplits that define portions of data to be produced by InputFormats.

Method Summary

Methods

Modifier and Type	Method and Description
T[]	createInputSplits(int minNumSplits) Computes the input splits.
InputSplitAssigner	getInputSplitAssigner(T[] inputSplits) Returns the assigner for the input splits.

Method Detail

createInputSplits

T[] createInputSplits(int minNumSplits)
                                         throws Exception

Computes the input splits. The given minimum number of splits is a hint as to how many splits are desired.

Parameters:

minNumSplits - Number of minimal input splits, as a hint.

Returns:

An array of input splits.

Throws:

Exception - Exceptions when creating the input splits may be forwarded and will cause the execution to permanently fail.

getInputSplitAssigner

InputSplitAssigner getInputSplitAssigner(T[] inputSplits)

Returns the assigner for the input splits. Assigner determines which parallel instance of the input format gets which input split.

Returns:

The input split assigner.