IN
- Input typeStreamingFileSink
for writing to files from a streaming program.@PublicEvolving @Deprecated public class OutputFormatSinkFunction<IN> extends RichSinkFunction<IN> implements InputTypeConfigurable
SinkFunction.Context
Constructor and Description |
---|
OutputFormatSinkFunction(OutputFormat<IN> format)
Deprecated.
|
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.
|
getIterationRuntimeContext, getRuntimeContext, open
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
finish, invoke, writeWatermark
public OutputFormatSinkFunction(OutputFormat<IN> format)
public void open(OpenContext openContext) throws Exception
RichFunction
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)
.
open
in interface RichFunction
openContext
- The context containing information about the context in which the function
is opened.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.public void setRuntimeContext(RuntimeContext context)
RichFunction
setRuntimeContext
in interface RichFunction
setRuntimeContext
in class AbstractRichFunction
context
- The runtime context.public void setInputType(TypeInformation<?> type, ExecutionConfig executionConfig)
InputTypeConfigurable
OutputFormat
when it is
passed to the DataSet's output method. May be used to configures the output format based on
the data type.setInputType
in interface InputTypeConfigurable
type
- The data type of the input.executionConfig
- The execution config for this parallel execution.public void invoke(IN record) throws Exception
invoke
in interface SinkFunction<IN>
Exception
public void close() throws IOException
RichFunction
This method can be used for clean up work.
close
in interface RichFunction
close
in class AbstractRichFunction
IOException
public OutputFormat<IN> getFormat()
Copyright © 2014–2023 The Apache Software Foundation. All rights reserved.