org.apache.flink.api.common.operators.base

Class FileDataSinkBase<IN>

java.lang.Object

org.apache.flink.api.common.operators.Operator<Nothing>

org.apache.flink.api.common.operators.GenericDataSinkBase<IN>

org.apache.flink.api.common.operators.base.FileDataSinkBase<IN>

All Implemented Interfaces:

Visitable<Operator<?>>

public class FileDataSinkBase<IN>
extends GenericDataSinkBase<IN>

Operator for nodes which act as data sinks, storing the data they receive in a file instead of sending it to another contract. The encoding of the data in the file is handled by the FileOutputFormat.

See Also:

FileOutputFormat

Field Summary

Fields

Modifier and Type	Field and Description
protected String	filePath

Fields inherited from class org.apache.flink.api.common.operators.GenericDataSinkBase

formatWrapper, input

Fields inherited from class org.apache.flink.api.common.operators.Operator

compilerHints, name, operatorInfo, parameters

Constructor Summary

Constructors

Constructor and Description
FileDataSinkBase(FileOutputFormat<IN> f, UnaryOperatorInformation<IN,Nothing> operatorInfo, String filePath, String name) Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path.
FileDataSinkBase(UserCodeWrapper<FileOutputFormat<IN>> f, UnaryOperatorInformation<IN,Nothing> operatorInfo, String filePath, String name) Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFilePath() Returns the configured file path where the output is written to.
String	toString()

Methods inherited from class org.apache.flink.api.common.operators.GenericDataSinkBase

accept, addInput, addInputs, executeOnCollections, getDataDistribution, getFormatWrapper, getInput, getLocalOrder, getPartitionOrdering, getUserCodeWrapper, setGlobalOrder, setGlobalOrder, setInput, setInputs, setInputs, setLocalOrder, setRangePartitioned, setRangePartitioned

Methods inherited from class org.apache.flink.api.common.operators.Operator

createUnionCascade, createUnionCascade, createUnionCascade, getCompilerHints, getName, getOperatorInfo, getParallelism, getParameters, setName, setParallelism, setParameter, setParameter, setParameter

Methods inherited from class java.lang.Object

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

Field Detail

filePath

protected final String filePath

Constructor Detail

FileDataSinkBase

public FileDataSinkBase(FileOutputFormat<IN> f,
                UnaryOperatorInformation<IN,Nothing> operatorInfo,
                String filePath,
                String name)

Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

filePath - The path to the file to write the contents to.

name - The given name for the sink, used in plans, logs and progress messages.

FileDataSinkBase

public FileDataSinkBase(UserCodeWrapper<FileOutputFormat<IN>> f,
                UnaryOperatorInformation<IN,Nothing> operatorInfo,
                String filePath,
                String name)

Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

filePath - The path to the file to write the contents to.

name - The given name for the sink, used in plans, logs and progress messages.

Method Detail

getFilePath

public String getFilePath()

Returns the configured file path where the output is written to.

Returns:

The path to which the output shall be written.

toString

public String toString()

Overrides:

toString in class GenericDataSinkBase<IN>