org.apache.flink.streaming.api.functions.sink

Class OutputFormatSinkFunction<IN>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.sink.RichSinkFunction<IN>

org.apache.flink.streaming.api.functions.sink.OutputFormatSinkFunction<IN>

Type Parameters:

IN - Input type

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.api.java.typeutils.InputTypeConfigurable, SinkFunction<IN>

@PublicEvolving
public class OutputFormatSinkFunction<IN>
extends RichSinkFunction<IN>
implements org.apache.flink.api.java.typeutils.InputTypeConfigurable

Simple implementation of the SinkFunction writing tuples in the specified OutputFormat format.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OutputFormatSinkFunction(org.apache.flink.api.common.io.OutputFormat<IN> format)

Method Summary

Modifier and Type	Method and Description
void	close()
void	invoke(IN record) Function for standard sink behaviour.
void	open(org.apache.flink.configuration.Configuration parameters)
void	setInputType(org.apache.flink.api.common.typeinfo.TypeInformation<?> type, org.apache.flink.api.common.ExecutionConfig executionConfig)

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputFormatSinkFunction

public OutputFormatSinkFunction(org.apache.flink.api.common.io.OutputFormat<IN> format)

Method Detail

open

public void open(org.apache.flink.configuration.Configuration parameters)
          throws Exception

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

open in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

Exception

setInputType

public void setInputType(org.apache.flink.api.common.typeinfo.TypeInformation<?> type,
                         org.apache.flink.api.common.ExecutionConfig executionConfig)

Specified by:

setInputType in interface org.apache.flink.api.java.typeutils.InputTypeConfigurable

invoke

public void invoke(IN record)
            throws Exception

Description copied from interface: SinkFunction

Function for standard sink behaviour. This function is called for every record.

Specified by:

invoke in interface SinkFunction<IN>

Specified by:

invoke in class RichSinkFunction<IN>

Parameters:

record - The input record.

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

close in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

IOException