CkRollupAggregationSpec

Namespace: Meshmakers.Octo.Runtime.Contracts.StreamData

Minimal projection of a CkRollupAggregation record — the source column on the source archive, the aggregation function, and an optional explicit target column name. The CK record carries additional fields in some models; the lifecycle / orchestrator only depends on these.

public record CkRollupAggregationSpec : IEquatable<CkRollupAggregationSpec>

Inheritance Object → CkRollupAggregationSpec
Implements IEquatable<CkRollupAggregationSpec>

Properties

SourcePath

Attribute path on the source archive. Must resolve against the source archive's Columns list (not the CK type directly) at activation time. For chained rollups that read from a stored AVG, address the materialised _sum/_count columns by name.

public string SourcePath { get; set; }

Property Value

String

Function

The aggregation function applied to CkRollupAggregationSpec.SourcePath.

public CkRollupFunction Function { get; set; }

Property Value

CkRollupFunction

TargetColumnName

Optional explicit storage column name. null defaults to "{sourcePath}_{function}" lower-cased. For CkRollupFunction.Avg, two columns are emitted with suffixes _sum and _count derived from this base name.

public string TargetColumnName { get; set; }

Property Value

String

ComparisonValue

State literal a CkRollupFunction.StateDuration aggregation matches the source column against — a number ("2", "100"), a boolean ("true"/"false") or a string state name. Required for StateDuration; ignored for every other function. AB#4336.

public string ComparisonValue { get; set; }

Property Value

String

Constructors

CkRollupAggregationSpec(String, CkRollupFunction, String, String)

Minimal projection of a CkRollupAggregation record — the source column on the source archive, the aggregation function, and an optional explicit target column name. The CK record carries additional fields in some models; the lifecycle / orchestrator only depends on these.

public CkRollupAggregationSpec(string SourcePath, CkRollupFunction Function, string TargetColumnName, string ComparisonValue)

Parameters

SourcePath String
Attribute path on the source archive. Must resolve against the source archive's Columns list (not the CK type directly) at activation time. For chained rollups that read from a stored AVG, address the materialised _sum/_count columns by name.

Function CkRollupFunction
The aggregation function applied to CkRollupAggregationSpec.SourcePath.

TargetColumnName String
Optional explicit storage column name. null defaults to "{sourcePath}_{function}" lower-cased. For CkRollupFunction.Avg, two columns are emitted with suffixes _sum and _count derived from this base name.

ComparisonValue String
State literal a CkRollupFunction.StateDuration aggregation matches the source column against — a number ("2", "100"), a boolean ("true"/"false") or a string state name. Required for StateDuration; ignored for every other function. AB#4336.