org.apache.samza.operators.functions

Interface StreamTableJoinFunction<K,M,R,JM>

Type Parameters:

K - the type of join key

M - type of input message

R - type of the table record

JM - type of join results

All Superinterfaces:

ClosableFunction, InitableFunction, java.io.Serializable

@InterfaceStability.Unstable
public interface StreamTableJoinFunction<K,M,R,JM>
extends InitableFunction, ClosableFunction, java.io.Serializable

Joins incoming messages with records from a table by the join key.

Method Summary

Modifier and Type	Method and Description
JM	apply(M message, R record) Joins the provided messages and table record, returns the joined message.
K	getMessageKey(M message) Retrieve the join key from incoming messages
K	getRecordKey(R record) Retrieve the join key from table record

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

JM apply(M message,
         R record)

Joins the provided messages and table record, returns the joined message.

Parameters:

message - the input message

record - the table record value

Returns:

the join result

getMessageKey

K getMessageKey(M message)

Retrieve the join key from incoming messages

Parameters:

message - incoming message

Returns:

the join key

getRecordKey

K getRecordKey(R record)

Retrieve the join key from table record

Parameters:

record - table record

Returns:

the join key