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>

Deprecated.

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

@PublicEvolving
 @Deprecated
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

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(org.apache.flink.api.common.io.OutputFormat<IN> format) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
org.apache.flink.api.common.io.OutputFormat<IN>	getFormat() Deprecated.
void	invoke(IN record) Deprecated.
void	open(org.apache.flink.configuration.Configuration parameters) Deprecated. This method is deprecated since Flink 1.19. The users are recommended to implement open(OpenContext openContext) and override open(Configuration parameters) with an empty body instead. 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).
void	setInputType(org.apache.flink.api.common.typeinfo.TypeInformation<?> type, org.apache.flink.api.common.ExecutionConfig executionConfig) Deprecated.
void	setRuntimeContext(org.apache.flink.api.common.functions.RuntimeContext context) Deprecated.

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

getIterationRuntimeContext, getRuntimeContext

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

Methods inherited from interface org.apache.flink.api.common.functions.RichFunction

open

Constructor Detail

OutputFormatSinkFunction

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

Deprecated.

Method Detail

open

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

Deprecated. This method is deprecated since Flink 1.19. The users are recommended to implement open(OpenContext openContext) and override open(Configuration parameters) with an empty body instead. 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).

Initialization method for the OutputFormatSinkFunction.

Specified by:

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

Overrides:

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

Parameters:

parameters - The configuration containing the parameters attached to the contract.

Throws:

Exception - if an error happens.

See Also:

FLIP-344: Remove parameter in RichFunction#open

setRuntimeContext

public void setRuntimeContext(org.apache.flink.api.common.functions.RuntimeContext context)

Deprecated.

Specified by:

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

Overrides:

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

setInputType

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

Deprecated.

Specified by:

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

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.

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

getFormat

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

Deprecated.