org.apache.samza.operators.functions

Interface JoinFunction<K,M,JM,RM>

Type Parameters:

K - type of the join key

M - type of the input message

JM - type of the message to join with

RM - type of the joined message

All Superinterfaces:

ClosableFunction, InitableFunction

@InterfaceStability.Unstable
public interface JoinFunction<K,M,JM,RM>
extends InitableFunction, ClosableFunction

Joins incoming messages in two streams by key.

Method Summary

Modifier and Type	Method and Description
RM	apply(M message, JM otherMessage) Joins the provided messages and returns the joined message.
K	getFirstKey(M message) Get the join key for messages in the first input stream.
K	getSecondKey(JM message) Get the join key for messages in the second input stream.

Methods inherited from interface org.apache.samza.operators.functions.InitableFunction

init

Methods inherited from interface org.apache.samza.operators.functions.ClosableFunction

close

Method Detail

apply

RM apply(M message,
         JM otherMessage)

Joins the provided messages and returns the joined message.

Parameters:

message - the input message

otherMessage - the message to join with

Returns:

the joined message

getFirstKey

K getFirstKey(M message)

Get the join key for messages in the first input stream.

Parameters:

message - the message in the first input stream

Returns:

the join key

getSecondKey

K getSecondKey(JM message)

Get the join key for messages in the second input stream.

Parameters:

message - the message in the second input stream

Returns:

the join key