org.apache.flink.python.api.functions

Class PythonCoGroup<IN1,IN2,OUT>

java.lang.Object

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

org.apache.flink.api.common.functions.RichCoGroupFunction<IN1,IN2,OUT>

org.apache.flink.python.api.functions.PythonCoGroup<IN1,IN2,OUT>

Type Parameters:

IN1 -

IN2 -

OUT -

All Implemented Interfaces:

Serializable, CoGroupFunction<IN1,IN2,OUT>, Function, RichFunction, ResultTypeQueryable<OUT>

public class PythonCoGroup<IN1,IN2,OUT>
extends RichCoGroupFunction<IN1,IN2,OUT>
implements ResultTypeQueryable<OUT>

CoGroupFunction that uses a python script.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PythonCoGroup(Configuration config, int envID, int setID, TypeInformation<OUT> typeInformation)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this function.
void	coGroup(Iterable<IN1> first, Iterable<IN2> second, Collector<OUT> out) Calls the external python function.
TypeInformation<OUT>	getProducedType() Gets the data type (as a TypeInformation) produced by this function or input format.
void	open(Configuration config) Opens this function.

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

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

PythonCoGroup

public PythonCoGroup(Configuration config,
                     int envID,
                     int setID,
                     TypeInformation<OUT> typeInformation)

Method Detail

open

public void open(Configuration config)
          throws IOException

Opens this function.

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Parameters:

config - configuration

Throws:

IOException

See Also:

Configuration

coGroup

public final void coGroup(Iterable<IN1> first,
                          Iterable<IN2> second,
                          Collector<OUT> out)
                   throws Exception

Calls the external python function.

Specified by:

coGroup in interface CoGroupFunction<IN1,IN2,OUT>

Specified by:

coGroup in class RichCoGroupFunction<IN1,IN2,OUT>

Parameters:

first -

second -

out - collector

Throws:

IOException

Exception - The function may throw Exceptions, which will cause the program to cancel, and may trigger the recovery logic.

close

public void close()
           throws IOException

Closes this function.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

IOException

getProducedType

public TypeInformation<OUT> getProducedType()

Description copied from interface: ResultTypeQueryable

Gets the data type (as a TypeInformation) produced by this function or input format.

Specified by:

getProducedType in interface ResultTypeQueryable<OUT>

Returns:

The data type produced by this function or input format.