org.apache.flink.api.java.record.operators

Class FileDataSink

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<Record>

org.apache.flink.api.java.record.operators.FileDataSink

All Implemented Interfaces:

Visitable<Operator<?>>

Deprecated.

@Deprecated
public class FileDataSink
extends FileDataSinkBase<Record>

NOTE: The Record API is marked as deprecated. It is not being developed anymore and will be removed from the code at some point. See FLINK-1106 for more details. 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 inherited from class org.apache.flink.api.common.operators.base.FileDataSinkBase

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
FileDataSink(Class<? extends FileOutputFormat<Record>> f, String filePath) Deprecated. Creates a FileDataSink with the provided FileOutputFormat implementation and a default name, writing to the file indicated by the given path.
FileDataSink(Class<? extends FileOutputFormat<Record>> f, String filePath, List<Operator<Record>> input) Deprecated. This method will be removed in future versions. Use the Union operator instead.
FileDataSink(Class<? extends FileOutputFormat<Record>> f, String filePath, List<Operator<Record>> input, String name) Deprecated. This method will be removed in future versions. Use the Union operator instead.
FileDataSink(Class<? extends FileOutputFormat<Record>> f, String filePath, Operator<Record> input) Deprecated. Creates a FileDataSink with the provided FileOutputFormat implementation the default name, writing to the file indicated by the given path.
FileDataSink(Class<? extends FileOutputFormat<Record>> f, String filePath, Operator<Record> input, String name) Deprecated. Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path.
FileDataSink(Class<? extends FileOutputFormat<Record>> f, String filePath, String name) Deprecated. Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path.
FileDataSink(FileOutputFormat<Record> f, String filePath) Deprecated. Creates a FileDataSink with the provided FileOutputFormat implementation and a default name, writing to the file indicated by the given path.
FileDataSink(FileOutputFormat<Record> f, String filePath, List<Operator<Record>> input) Deprecated. This method will be removed in future versions. Use the Union operator instead.
FileDataSink(FileOutputFormat<Record> f, String filePath, List<Operator<Record>> input, String name) Deprecated. This method will be removed in future versions. Use the Union operator instead.
FileDataSink(FileOutputFormat<Record> f, String filePath, Operator<Record> input) Deprecated. Creates a FileDataSink with the provided FileOutputFormat implementation the default name, writing to the file indicated by the given path.
FileDataSink(FileOutputFormat<Record> f, String filePath, Operator<Record> input, String name) Deprecated. Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path.
FileDataSink(FileOutputFormat<Record> f, String filePath, String name) Deprecated. 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() Deprecated. Returns the configured file path where the output is written to.
String	toString() Deprecated.

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, getDegreeOfParallelism, getName, getOperatorInfo, getParameters, setDegreeOfParallelism, setName, setParameter, setParameter, setParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDataSink

public FileDataSink(FileOutputFormat<Record> f,
            String filePath,
            String name)

Deprecated.

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.

FileDataSink

public FileDataSink(FileOutputFormat<Record> f,
            String filePath)

Deprecated.

Creates a FileDataSink with the provided FileOutputFormat implementation and a default 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.

FileDataSink

public FileDataSink(FileOutputFormat<Record> f,
            String filePath,
            Operator<Record> input)

Deprecated.

Creates a FileDataSink with the provided FileOutputFormat implementation the default name, writing to the file indicated by the given path. It uses the given contract as its input.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

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

input - The contract to use as the input.

FileDataSink

@Deprecated
public FileDataSink(FileOutputFormat<Record> f,
                       String filePath,
                       List<Operator<Record>> input)

Deprecated. This method will be removed in future versions. Use the Union operator instead.

Creates a FileDataSink with the provided FileOutputFormat implementation the default name, writing to the file indicated by the given path. It uses the given contracts as its input.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

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

input - The contracts to use as the input.

FileDataSink

public FileDataSink(FileOutputFormat<Record> f,
            String filePath,
            Operator<Record> input,
            String name)

Deprecated.

Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path. It uses the given contract as its input.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

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

input - The contract to use as the input.

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

FileDataSink

@Deprecated
public FileDataSink(FileOutputFormat<Record> f,
                       String filePath,
                       List<Operator<Record>> input,
                       String name)

Deprecated. This method will be removed in future versions. Use the Union operator instead.

Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path. It uses the given contracts as its input.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

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

input - The contracts to use as the input.

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

FileDataSink

public FileDataSink(Class<? extends FileOutputFormat<Record>> f,
            String filePath,
            String name)

Deprecated.

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.

FileDataSink

public FileDataSink(Class<? extends FileOutputFormat<Record>> f,
            String filePath)

Deprecated.

Creates a FileDataSink with the provided FileOutputFormat implementation and a default 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.

FileDataSink

public FileDataSink(Class<? extends FileOutputFormat<Record>> f,
            String filePath,
            Operator<Record> input)

Deprecated.

Creates a FileDataSink with the provided FileOutputFormat implementation the default name, writing to the file indicated by the given path. It uses the given contract as its input.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

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

input - The contract to use as the input.

FileDataSink

@Deprecated
public FileDataSink(Class<? extends FileOutputFormat<Record>> f,
                       String filePath,
                       List<Operator<Record>> input)

Deprecated. This method will be removed in future versions. Use the Union operator instead.

Creates a FileDataSink with the provided FileOutputFormat implementation the default name, writing to the file indicated by the given path. It uses the given contracts as its input.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

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

input - The contracts to use as the input.

FileDataSink

public FileDataSink(Class<? extends FileOutputFormat<Record>> f,
            String filePath,
            Operator<Record> input,
            String name)

Deprecated.

Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path. It uses the given contract as its input.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

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

input - The contract to use as the input.

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

FileDataSink

@Deprecated
public FileDataSink(Class<? extends FileOutputFormat<Record>> f,
                       String filePath,
                       List<Operator<Record>> input,
                       String name)

Deprecated. This method will be removed in future versions. Use the Union operator instead.

Creates a FileDataSink with the provided FileOutputFormat implementation and the given name, writing to the file indicated by the given path. It uses the given contracts as its input.

Parameters:

f - The FileOutputFormat implementation used to encode the data.

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

input - The contracts to use as the input.

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

Method Detail

getFilePath

public String getFilePath()

Deprecated.

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

Overrides:

getFilePath in class FileDataSinkBase<Record>

Returns:

The path to which the output shall be written.

toString

public String toString()

Deprecated.

Overrides:

toString in class FileDataSinkBase<Record>