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

Class PrintSinkFunction<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.PrintSinkFunction<IN>

Type Parameters:

IN - Input record type

All Implemented Interfaces:

Serializable, Function, RichFunction, SupportsConcurrentExecutionAttempts, SinkFunction<IN>

Deprecated.

This interface will be removed in future versions. Use the new PrintSink interface instead.

@Deprecated
 @PublicEvolving
public class PrintSinkFunction<IN>
extends RichSinkFunction<IN>
implements SupportsConcurrentExecutionAttempts

Implementation of the SinkFunction writing every tuple to the standard output or standard error stream.

Four possible format options: sinkIdentifier:taskId> output <- sinkIdentifier provided, parallelism > 1 sinkIdentifier> output <- sinkIdentifier provided, parallelism == 1 taskId> output <- no sinkIdentifier provided, parallelism > 1 output <- no sinkIdentifier provided, parallelism == 1

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
PrintSinkFunction() Deprecated. Instantiates a print sink function that prints to standard out.
PrintSinkFunction(boolean stdErr) Deprecated. Instantiates a print sink function that prints to standard out.
PrintSinkFunction(String sinkIdentifier, boolean stdErr) Deprecated. Instantiates a print sink function that prints to standard out and gives a sink identifier.

Method Summary

Modifier and Type	Method and Description
void	invoke(IN record) Deprecated.
void	open(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).
String	toString() Deprecated.

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

close, getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

PrintSinkFunction

public PrintSinkFunction()

Deprecated.

Instantiates a print sink function that prints to standard out.

PrintSinkFunction

public PrintSinkFunction(boolean stdErr)

Deprecated.

Instantiates a print sink function that prints to standard out.

Parameters:

stdErr - True, if the format should print to standard error instead of standard out.

PrintSinkFunction

public PrintSinkFunction(String sinkIdentifier,
                         boolean stdErr)

Deprecated.

Instantiates a print sink function that prints to standard out and gives a sink identifier.

Parameters:

stdErr - True, if the format should print to standard error instead of standard out.

sinkIdentifier - Message that identify sink and is prefixed to the output of the value

Method Detail

open

@Deprecated
public void open(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 PrintSinkFunction.

Specified by:

open in interface RichFunction

Overrides:

open in class 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

invoke

public void invoke(IN record)

Deprecated.

Specified by:

invoke in interface SinkFunction<IN>

toString

public String toString()

Deprecated.

Overrides:

toString in class Object