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 Object
TheJoined
class represents optional params that can be passed toKStream#join(KTable,...)
andKStream#leftJoin(KTable,...)
operations.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <K,V,VO>
Joined<K,V,VO>as(String name)
Create an instance ofJoined
with base name for all components of the join, this may include any repartition topics created to complete the join.Serde<K>
keySerde()
static <K,V,VO>
Joined<K,V,VO>keySerde(Serde<K> keySerde)
Create an instance ofJoined
with a keySerde
.String
name()
Deprecated.this method will be removed in a in a future releasestatic <K,V,VO>
Joined<K,V,VO>named(String name)
Deprecated.useas(String)
insteadSerde<VO>
otherValueSerde()
static <K,V,VO>
Joined<K,V,VO>otherValueSerde(Serde<VO> otherValueSerde)
Create an instance ofJoined
with an other valueSerde
.Serde<V>
valueSerde()
static <K,V,VO>
Joined<K,V,VO>valueSerde(Serde<V> valueSerde)
Create an instance ofJoined
with a valueSerde
.static <K,V,VO>
Joined<K,V,VO>with(Serde<K> keySerde, Serde<V> valueSerde, Serde<VO> otherValueSerde)
Create an instance ofJoined
with key, value, and otherValueSerde
instances.static <K,V,VO>
Joined<K,V,VO>with(Serde<K> keySerde, Serde<V> valueSerde, Serde<VO> otherValueSerde, String name)
Create an instance ofJoined
with key, value, and otherValueSerde
instances.Joined<K,V,VO>
withKeySerde(Serde<K> keySerde)
Set the keySerde
to be used.Joined<K,V,VO>
withName(String name)
Set the base name used for all components of the join, this may include any repartition topics created to complete the join.Joined<K,V,VO>
withOtherValueSerde(Serde<VO> otherValueSerde)
Set the otherValueSerde
to be used.Joined<K,V,VO>
withValueSerde(Serde<V> valueSerde)
Set the valueSerde
to be used.
-
-
-
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 ofJoined
with key, value, and otherValueSerde
instances.null
values are accepted and will be replaced by the default serdes as defined in config.- Type Parameters:
K
- key typeV
- value typeVO
- other value type- Parameters:
keySerde
- the key serde to use. Ifnull
the default key serde from config will be usedvalueSerde
- the value serde to use. Ifnull
the default value serde from config will be usedotherValueSerde
- the otherValue serde to use. Ifnull
the default value serde from config will be used- Returns:
- new
Joined
instance with the provided serdes
-
with
public static <K,V,VO> Joined<K,V,VO> with(Serde<K> keySerde, Serde<V> valueSerde, Serde<VO> otherValueSerde, String name)
Create an instance ofJoined
with key, value, and otherValueSerde
instances.null
values are accepted and will be replaced by the default serdes as defined in config.- Type Parameters:
K
- key typeV
- value typeVO
- other value type- Parameters:
keySerde
- the key serde to use. Ifnull
the default key serde from config will be usedvalueSerde
- the value serde to use. Ifnull
the default value serde from config will be usedotherValueSerde
- the otherValue serde to use. Ifnull
the default value serde from config will be usedname
- the name used as the base for naming components of the join including any repartition topics- 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 ofJoined
with a keySerde
.null
values are accepted and will be replaced by the default key serde as defined in config.- Type Parameters:
K
- key typeV
- value typeVO
- other value type- Parameters:
keySerde
- the key serde to use. Ifnull
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 ofJoined
with a valueSerde
.null
values are accepted and will be replaced by the default value serde as defined in config.- Type Parameters:
K
- key typeV
- value typeVO
- other value type- Parameters:
valueSerde
- the value serde to use. Ifnull
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 ofJoined
with an other valueSerde
.null
values are accepted and will be replaced by the default value serde as defined in config.- Type Parameters:
K
- key typeV
- value typeVO
- other value type- Parameters:
otherValueSerde
- the otherValue serde to use. Ifnull
the default value serde from config will be used- Returns:
- new
Joined
instance configured with the otherValueSerde
-
named
@Deprecated public static <K,V,VO> Joined<K,V,VO> named(String name)
Deprecated.useas(String)
insteadCreate an instance ofJoined
with base name for all components of the join, this may include any repartition topics created to complete the join.- Type Parameters:
K
- key typeV
- value typeVO
- other value type- Parameters:
name
- the name used as the base for naming components of the join including any repartition topics- Returns:
- new
Joined
instance configured with the name
-
as
public static <K,V,VO> Joined<K,V,VO> as(String name)
Create an instance ofJoined
with base name for all components of the join, this may include any repartition topics created to complete the join.- Type Parameters:
K
- key typeV
- value typeVO
- other value type- Parameters:
name
- the name used as the base for naming components of the join including any repartition topics- Returns:
- new
Joined
instance configured with the name
-
withKeySerde
public Joined<K,V,VO> withKeySerde(Serde<K> keySerde)
Set the keySerde
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:
- new
Joined
instance configured with thename
-
withValueSerde
public Joined<K,V,VO> withValueSerde(Serde<V> valueSerde)
Set the valueSerde
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:
- new
Joined
instance configured with thevalueSerde
-
withOtherValueSerde
public Joined<K,V,VO> withOtherValueSerde(Serde<VO> otherValueSerde)
Set the otherValueSerde
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:
- new
Joined
instance configured with thevalueSerde
-
withName
public Joined<K,V,VO> withName(String name)
Set the base name used for all components of the join, this may include any repartition topics created to complete the join.- Parameters:
name
- the name used as the base for naming components of the join including any repartition topics- Returns:
- new
Joined
instance configured with thename
-
name
@Deprecated public String name()
Deprecated.this method will be removed in a in a future release
-
-