TimeWindowedSerializer and TimeWindowedSerde

Author: jaceklaskowski

SUMMARY.adoc

@@ -58,7 +58,9 @@
 .. link:kafka-streams-SessionWindow.adoc[SessionWindow]
 .. link:kafka-streams-TimeWindow.adoc[TimeWindow]
 
-. link:kafka-streams-Windowed.adoc[Windowed]
+. link:kafka-streams-WindowedSerdes.adoc[WindowedSerdes -- SessionWindowedSerde and TimeWindowedSerde]
+.. link:kafka-streams-Windowed.adoc[Windowed]
+.. link:kafka-streams-TimeWindowedSerializer.adoc[TimeWindowedSerializer]
 
 . link:kafka-streams-SessionKeySerde.adoc[SessionKeySerde]
 

kafka-streams-TimeWindowedSerializer.adoc

@@ -0,0 +1,10 @@
+== [[TimeWindowedSerializer]] TimeWindowedSerializer
+
+`TimeWindowedSerializer` is a <<kafka-streams-internals-WindowedSerializer.adoc#, WindowedSerializer>> for the keys of <<kafka-streams-WindowedSerdes.adoc#TimeWindowedSerde, WindowedSerdes.TimeWindowedSerde>> and `FullTimeWindowedSerde` windowed serdes.
+
+[[creating-instance]]
+[[inner]]
+`TimeWindowedSerializer` takes a Kafka https://kafka.apache.org/21/javadoc/org/apache/kafka/common/serialization/Serializer.html[Serializer] when created.
+
+[[configure]]
+When requested to configure, `TimeWindowedSerializer` uses <<kafka-streams-StreamsConfig.adoc#DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS, DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS>> and <<kafka-streams-StreamsConfig.adoc#DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS, DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS>> configuration properties for the serde of keys and values, respectively, unless the <<inner, Serializer>> is defined already.

kafka-streams-WindowedSerdes.adoc

@@ -0,0 +1,43 @@
+== [[WindowedSerdes]] WindowedSerdes -- SessionWindowedSerde and TimeWindowedSerde
+
+`WindowedSerdes` is a class that acts as a namespace for two static classes:
+
+* [[SessionWindowedSerde]] `SessionWindowedSerde` for session-windowed aggregations
+* [[TimeWindowedSerde]] `TimeWindowedSerde` for time-windowed aggregation
+
+`WindowedSerdes` also defines two <<factory-methods, factory methods>> to create instances of <<timeWindowedSerdeFrom, TimeWindowedSerde>> and <<sessionWindowedSerdeFrom, SessionWindowedSerde>> for the specified inner class type.
+
+[[factory-methods]]
+.WindowedSerdes's Factory Methods
+[cols="1m,2",options="header",width="100%"]
+|===
+| Method
+| Description
+
+| sessionWindowedSerdeFrom
+a| [[sessionWindowedSerdeFrom]]
+
+[source, java]
+----
+Serde<Windowed<T>> sessionWindowedSerdeFrom(
+  final Class<T> type)
+----
+
+| timeWindowedSerdeFrom
+a| [[timeWindowedSerdeFrom]]
+
+[source, java]
+----
+Serde<Windowed<T>> timeWindowedSerdeFrom(
+  final Class<T> type)
+----
+
+|===
+
+=== Scala API for Kafka Streams
+
+<<kafka-streams-scala-Serdes.adoc#, Serdes>> object defines the following implicit conversions to create instances of `TimeWindowedSerde` and `SessionWindowedSerde` (without an explicit inner class type):
+
+* <<kafka-streams-scala-Serdes.adoc#sessionWindowedSerde, sessionWindowedSerde>> for a <<SessionWindowedSerde, WindowedSerdes.SessionWindowedSerde[T]>> instance
+
+* <<kafka-streams-scala-Serdes.adoc#timeWindowedSerde, timeWindowedSerde>> for a <<TimeWindowedSerde, WindowedSerdes.TimeWindowedSerde[T]>> instance

kafka-streams-internals-WindowedSerializer.adoc

@@ -23,7 +23,7 @@ byte[] serializeBaseKey(String topic, Windowed<T> data)
 | SessionWindowedSerializer
 | [[SessionWindowedSerializer]]
 
-| TimeWindowedSerializer
+| <<kafka-streams-TimeWindowedSerializer.adoc#, TimeWindowedSerializer>>
 | [[TimeWindowedSerializer]]
 
 |===

kafka-streams-scala-Serdes.adoc

@@ -58,10 +58,10 @@ Serdes.String.getClass.getName
 | [[String]] Serde[String]
 
 | sessionWindowedSerde[T]
-| [[sessionWindowedSerde]] WindowedSerdes.SessionWindowedSerde[T]
+| [[sessionWindowedSerde]] <<kafka-streams-WindowedSerdes.adoc#SessionWindowedSerde, WindowedSerdes.SessionWindowedSerde[T]>>
 
 | timeWindowedSerde[T]
-| [[timeWindowedSerde]] WindowedSerdes.TimeWindowedSerde[T]
+| [[timeWindowedSerde]] <<kafka-streams-WindowedSerdes.adoc#TimeWindowedSerde, WindowedSerdes.TimeWindowedSerde[T]>>
 |===
 
 === [[fromFn]] `fromFn` Method