Package org.apache.kafka.streams.kstream

Class Joined<K,V,VO>

java.lang.Object

org.apache.kafka.streams.kstream.Joined<K,V,VO>

public class Joined<K,V,VO>
extends java.lang.Object

The Joined class represents optional params that can be passed to KStream.join(org.apache.kafka.streams.kstream.KStream<K, VO>, org.apache.kafka.streams.kstream.ValueJoiner<? super V, ? super VO, ? extends VR>, org.apache.kafka.streams.kstream.JoinWindows), KStream.leftJoin(org.apache.kafka.streams.kstream.KStream<K, VO>, org.apache.kafka.streams.kstream.ValueJoiner<? super V, ? super VO, ? extends VR>, org.apache.kafka.streams.kstream.JoinWindows), and KStream.outerJoin(org.apache.kafka.streams.kstream.KStream<K, VO>, org.apache.kafka.streams.kstream.ValueJoiner<? super V, ? super VO, ? extends VR>, org.apache.kafka.streams.kstream.JoinWindows) operations.

Method Summary

Modifier and Type	Method	Description
Serde<K>	keySerde()
static <K,V,VO> Joined<K,V,VO>	keySerde(Serde<K> keySerde)	Create an instance of Joined with a key Serde.
Serde<VO>	otherValueSerde()
static <K,V,VO> Joined<K,V,VO>	otherValueSerde(Serde<VO> otherValueSerde)	Create an instance of Joined with an other value Serde.
Serde<V>	valueSerde()
static <K,V,VO> Joined<K,V,VO>	valueSerde(Serde<V> valueSerde)	Create an instance of Joined with a value Serde.
static <K,V,VO> Joined<K,V,VO>	with(Serde<K> keySerde, Serde<V> valueSerde, Serde<VO> otherValueSerde)	Create an instance of Joined with key, value, and otherValue Serde instances.
Joined<K,V,VO>	withKeySerde(Serde<K> keySerde)	Set the key Serde to be used.
Joined<K,V,VO>	withOtherValueSerde(Serde<VO> otherValueSerde)	Set the otherValue Serde to be used.
Joined<K,V,VO>	withValueSerde(Serde<V> valueSerde)	Set the value Serde to be used.

Methods inherited from class java.lang.Object

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

Method Detail

with

public static <K,V,VO> Joined<K,V,VO> with(Serde<K> keySerde,
                                           Serde<V> valueSerde,
                                           Serde<VO> otherValueSerde)

Create an instance of Joined with key, value, and otherValue Serde instances. null values are accepted and will be replaced by the default serdes as defined in config.

Type Parameters:

K - key type

V - value type

VO - other value type

Parameters:

keySerde - the key serde to use. If null the default key serde from config will be used

valueSerde - the value serde to use. If null the default value serde from config will be used

otherValueSerde - the otherValue serde to use. If null the default value serde from config will be used

Returns:

new Joined instance with the provided serdes

keySerde

public static <K,V,VO> Joined<K,V,VO> keySerde(Serde<K> keySerde)

Create an instance of Joined with a key Serde. null values are accepted and will be replaced by the default key serde as defined in config.

Type Parameters:

K - key type

V - value type

VO - other value type

Parameters:

keySerde - the key serde to use. If null the default key serde from config will be used

Returns:

new Joined instance configured with the keySerde

valueSerde

public static <K,V,VO> Joined<K,V,VO> valueSerde(Serde<V> valueSerde)

Create an instance of Joined with a value Serde. null values are accepted and will be replaced by the default value serde as defined in config.

Type Parameters:

K - key type

V - value type

VO - other value type

Parameters:

valueSerde - the value serde to use. If null the default value serde from config will be used

Returns:

new Joined instance configured with the valueSerde

otherValueSerde

public static <K,V,VO> Joined<K,V,VO> otherValueSerde(Serde<VO> otherValueSerde)

Create an instance of Joined with an other value Serde. null values are accepted and will be replaced by the default value serde as defined in config.

Type Parameters:

K - key type

V - value type

VO - other value type

Parameters:

otherValueSerde - the otherValue serde to use. If null the default value serde from config will be used

Returns:

new Joined instance configured with the otherValueSerde

withKeySerde

public Joined<K,V,VO> withKeySerde(Serde<K> keySerde)

Set the key Serde to be used. Null values are accepted and will be replaced by the default key serde as defined in config

Parameters:

keySerde - the key serde to use. If null the default key serde from config will be used

Returns:

this

withValueSerde

public Joined<K,V,VO> withValueSerde(Serde<V> valueSerde)

Set the value Serde to be used. Null values are accepted and will be replaced by the default value serde as defined in config

Parameters:

valueSerde - the value serde to use. If null the default value serde from config will be used

Returns:

this

withOtherValueSerde

public Joined<K,V,VO> withOtherValueSerde(Serde<VO> otherValueSerde)

Set the otherValue Serde to be used. Null values are accepted and will be replaced by the default value serde as defined in config

Parameters:

otherValueSerde - the otherValue serde to use. If null the default value serde from config will be used

Returns:

this

keySerde

public Serde<K> keySerde()

valueSerde

public Serde<V> valueSerde()

otherValueSerde

public Serde<VO> otherValueSerde()