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, Function, RichFunction, InputTypeConfigurable, SinkFunction<IN>

Deprecated.

Please use the StreamingFileSink for writing to files from a streaming program.

@PublicEvolving
 @Deprecated
public class OutputFormatSinkFunction<IN>
extends RichSinkFunction<IN>
implements InputTypeConfigurable

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

SinkFunction.Context

Constructor Summary

Constructors

Constructor and Description
OutputFormatSinkFunction(OutputFormat<IN> format) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated. Tear-down method for the user code.
OutputFormat<IN>	getFormat() Deprecated.
void	invoke(IN record) Deprecated.
void	open(OpenContext openContext) Deprecated. Initialization method for the function.
void	setInputType(TypeInformation<?> type, ExecutionConfig executionConfig) Deprecated. Method that is called on an OutputFormat when it is passed to the DataSet's output method.
void	setRuntimeContext(RuntimeContext context) Deprecated. Sets the function's runtime context.

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

getIterationRuntimeContext, getRuntimeContext, open

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

finish, invoke, writeWatermark

Constructor Detail

OutputFormatSinkFunction

public OutputFormatSinkFunction(OutputFormat<IN> format)

Deprecated.

Method Detail

open

public void open(OpenContext openContext)
          throws Exception

Deprecated.

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The openContext object passed to the function can be used for configuration and initialization. The openContext contains some necessary information that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(OpenContext openContext) {
         // initialize the value of searchString
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

1. If you implement open(OpenContext openContext), the open(OpenContext openContext) will be invoked and the open(Configuration parameters) won't be invoked. 2. If you don't implement open(OpenContext openContext), the open(Configuration parameters) will be invoked in the default implementation of the open(OpenContext openContext).

Specified by:

open in interface RichFunction

Parameters:

openContext - The context containing information about the context in which the function is opened.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

setRuntimeContext

public void setRuntimeContext(RuntimeContext context)

Deprecated.

Description copied from interface: RichFunction

Sets the function's runtime context. Called by the framework when creating a parallel instance of the function.

Specified by:

setRuntimeContext in interface RichFunction

Overrides:

setRuntimeContext in class AbstractRichFunction

Parameters:

context - The runtime context.

setInputType

public void setInputType(TypeInformation<?> type,
                         ExecutionConfig executionConfig)

Deprecated.

Description copied from interface: InputTypeConfigurable

Method that is called on an OutputFormat when it is passed to the DataSet's output method. May be used to configures the output format based on the data type.

Specified by:

setInputType in interface InputTypeConfigurable

Parameters:

type - The data type of the input.

executionConfig - The execution config for this parallel execution.

invoke

public void invoke(IN record)
            throws Exception

Deprecated.

Specified by:

invoke in interface SinkFunction<IN>

Throws:

Exception

close

public void close()
           throws IOException

Deprecated.

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

IOException

getFormat

public OutputFormat<IN> getFormat()

Deprecated.