RichJoinFunction (Flink : Core 1.20.1-cp1 API)

java.lang.Object
- org.apache.flink.api.common.functions.AbstractRichFunction
- - org.apache.flink.api.common.functions.RichJoinFunction<IN1,IN2,OUT>

Type Parameters:

IN1 - The type of the elements in the first input.

IN2 - The type of the elements in the second input.

OUT - The type of the result elements.

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, JoinFunction<IN1,IN2,OUT>, RichFunction
```
@Public
public abstract class RichJoinFunction<IN1,IN2,OUT>
extends AbstractRichFunction
implements JoinFunction<IN1,IN2,OUT>
```
Rich variant of the JoinFunction. As a RichFunction, it gives access to the RuntimeContext and provides setup and teardown methods: RichFunction.open(OpenContext) and RichFunction.close().

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

RichJoinFunction()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract OUT`	`join(IN1 first, IN2 second)`	The join method, called once per joined pair of elements.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction
close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

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.api.common.functions.RichFunction
open

- Constructor Detail
  - RichJoinFunction
```
public RichJoinFunction()
```
- Method Detail
  - join
```
public abstract OUT join(IN1 first,
                         IN2 second)
                  throws Exception
```
    Description copied from interface: JoinFunction
    
    The join method, called once per joined pair of elements.
    
    Specified by:
    
    join in interface JoinFunction<IN1,IN2,OUT>
    
    Parameters:
    
    first - The element from first input.
    
    second - The element from second input.
    
    Returns:
    
    The resulting element.
    
    Throws:
    
    Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.