Skip to content

Commit

Permalink
[ksqlDB.RestApi.Client]: added doc strings for WindowType enum
Browse files Browse the repository at this point in the history
  • Loading branch information
tomasfabian committed Mar 5, 2024
1 parent 6eedf93 commit b408a02
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions ksqlDb.RestApi.Client/KSql/RestApi/Enums/WindowType.cs
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
namespace ksqlDB.RestApi.Client.KSql.RestApi.Enums;
namespace ksqlDB.RestApi.Client.KSql.RestApi.Enums;

/// <summary>
/// Represents different windowing types in ksqlDB that have distinct time boundaries.
/// </summary>
public enum WindowType
{
/// <summary>
/// Represents a session window combines records into a session, delineating periods of activity separated by a defined duration of inactivity, known as "idleness".
/// </summary>
Session,

/// <summary>
/// Represents a hopping window where events are grouped into fixed-size, possibly overlapping, time intervals.
/// </summary>
Hopping,

/// <summary>
/// Represents a tumbling window where events are grouped into fixed-size, non-overlapping, time intervals.
/// </summary>
Tumbling
}
}

0 comments on commit b408a02

Please sign in to comment.