Skip to main content

SeriesResolutionResult

Namespace: Meshmakers.Octo.Runtime.Contracts.StreamData

The resolver's routing decision (shape A1): which archive to query, at what effective bucket width, how many points to expect, with which reducer, and a signal describing the outcome. The caller then issues the existing downsampling query (AB#4233) against SeriesResolutionResult.ArchiveRtId with limit = Points and the column aggregation set to SeriesResolutionResult.ReducingFunction. See concept-resolution-aware-series-queries.md §5.1.

public record SeriesResolutionResult : IEquatable<SeriesResolutionResult>

Inheritance Object → SeriesResolutionResult
Implements IEquatable<SeriesResolutionResult>

Properties​

ArchiveRtId​

The archive to query — a rollup, or the base archive for the refuse/raw paths.

public OctoObjectId ArchiveRtId { get; set; }

Property Value​

OctoObjectId

EffectiveBucketMs​

The width in milliseconds of one output bucket. For a reduced result this is (To - From) / Points; for an unreduced base result it is the base's native grain, or 0 when no bucketing applies / the grain is unknown.

public long EffectiveBucketMs { get; set; }

Property Value​

Int64

Points​

The number of points the caller can expect from the downsampling query.

public int Points { get; set; }

Property Value​

Int32

ReducingFunction​

The aggregation function the downsampling query must use.

public CkRollupFunction ReducingFunction { get; set; }

Property Value​

CkRollupFunction

Signal​

The outcome classification (see SeriesResolutionSignal).

public SeriesResolutionSignal Signal { get; set; }

Property Value​

SeriesResolutionSignal

ActualPoints​

The actually deliverable point count when it is below the requested target (SeriesResolutionSignal.ResolutionLimited) or the native raw count on the refuse path. Null when the target was met.

public Nullable<int> ActualPoints { get; set; }

Property Value​

Nullable<Int32>

Diagnostic​

Optional human-readable explanation of the chosen route / signal.

public string Diagnostic { get; set; }

Property Value​

String

Constructors​

SeriesResolutionResult(OctoObjectId, Int64, Int32, CkRollupFunction, SeriesResolutionSignal)​

The resolver's routing decision (shape A1): which archive to query, at what effective bucket width, how many points to expect, with which reducer, and a signal describing the outcome. The caller then issues the existing downsampling query (AB#4233) against SeriesResolutionResult.ArchiveRtId with limit = Points and the column aggregation set to SeriesResolutionResult.ReducingFunction. See concept-resolution-aware-series-queries.md §5.1.

public SeriesResolutionResult(OctoObjectId ArchiveRtId, long EffectiveBucketMs, int Points, CkRollupFunction ReducingFunction, SeriesResolutionSignal Signal)

Parameters​

ArchiveRtId OctoObjectId
The archive to query — a rollup, or the base archive for the refuse/raw paths.

EffectiveBucketMs Int64
The width in milliseconds of one output bucket. For a reduced result this is (To - From) / Points; for an unreduced base result it is the base's native grain, or 0 when no bucketing applies / the grain is unknown.

Points Int32
The number of points the caller can expect from the downsampling query.

ReducingFunction CkRollupFunction
The aggregation function the downsampling query must use.

Signal SeriesResolutionSignal
The outcome classification (see SeriesResolutionSignal).