org.apache.flink.state.api.output

Class BoundedOneInputStreamTaskRunner<IN>

java.lang.Object

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

org.apache.flink.api.common.functions.RichMapPartitionFunction<IN,TaggedOperatorSubtaskState>

org.apache.flink.state.api.output.BoundedOneInputStreamTaskRunner<IN>

Type Parameters:

IN - Type of the input to the partition

All Implemented Interfaces:

Serializable, Function, MapPartitionFunction<IN,TaggedOperatorSubtaskState>, RichFunction

@Internal
public class BoundedOneInputStreamTaskRunner<IN>
extends RichMapPartitionFunction<IN,TaggedOperatorSubtaskState>

A RichMapPartitionFunction that serves as the runtime for a BoundedStreamTask.

The task is executed processing the data in a particular partition instead of the pulling from the network stack. After all data has been processed the runner will output the OperatorSubtaskState from the snapshot of the bounded task.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BoundedOneInputStreamTaskRunner(StreamConfig streamConfig, int maxParallelism, Timestamper<IN> timestamper) Create a new BoundedOneInputStreamTaskRunner.

Method Summary

Modifier and Type	Method and Description
void	mapPartition(Iterable<IN> values, Collector<TaggedOperatorSubtaskState> out) A user-implemented function that modifies or transforms an incoming object.
void	open(Configuration parameters) Initialization method for the function.

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, toString, wait, wait, wait

Constructor Detail

BoundedOneInputStreamTaskRunner

public BoundedOneInputStreamTaskRunner(StreamConfig streamConfig,
                                       int maxParallelism,
                                       Timestamper<IN> timestamper)

Create a new BoundedOneInputStreamTaskRunner.

Parameters:

streamConfig - The internal configuration for the task.

maxParallelism - The max parallelism of the operator.

Method Detail

open

public void open(Configuration parameters)
          throws Exception

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 configuration object passed to the function can be used for configuration and initialization. The configuration contains all parameters that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(Configuration parameters) {
         this.searchString = parameters.getString("foo");
     }

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

By default, this method does nothing.

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Parameters:

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

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.

See Also:

Configuration

mapPartition

public void mapPartition(Iterable<IN> values,
                         Collector<TaggedOperatorSubtaskState> out)
                  throws Exception

Description copied from interface: MapPartitionFunction

A user-implemented function that modifies or transforms an incoming object.

Specified by:

mapPartition in interface MapPartitionFunction<IN,TaggedOperatorSubtaskState>

Specified by:

mapPartition in class RichMapPartitionFunction<IN,TaggedOperatorSubtaskState>

Parameters:

values - All records for the mapper

out - The collector to hand results to.

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.