Zum Hauptinhalt springen

ArchiveCoverageRung

Namespace: Meshmakers.Octo.Runtime.Contracts.StreamData

One rung of an archive family with its measured coverage (AB#5157) — the projection behind the coverageFor GraphQL query, the REST coverage endpoint and the MCP coverage tool.

public record ArchiveCoverageRung : IEquatable<ArchiveCoverageRung>

Inheritance Object → ArchiveCoverageRung
Implements IEquatable<ArchiveCoverageRung>

Properties​

ArchiveRtId​

Runtime id of the archive this rung describes.

public OctoObjectId ArchiveRtId { get; set; }

Property Value​

OctoObjectId

RtWellKnownName​

Optional human-readable name; null falls back to the rtId.

public string RtWellKnownName { get; set; }

Property Value​

String

IsBase​

True when the rung is not a rollup — i.e. the raw or time-range archive the family is keyed by. The base takes part in the resolver's coverage filter like any other rung.

public bool IsBase { get; set; }

Property Value​

Boolean

Status​

The rung's archive lifecycle status, so a client can tell a disabled rung from an empty one.

public CkArchiveStatus Status { get; set; }

Property Value​

CkArchiveStatus

BucketSizeMs​

The rung's native bucket width in milliseconds — a rollup's BucketSize, a time-range base archive's Period, and null for a raw base archive (no declared grain).

public Nullable<long> BucketSizeMs { get; set; }

Property Value​

Nullable<Int64>

Alignment​

Bucket-boundary alignment of the rung; BucketAlignment.FixedSize for a base archive, which has no calendar alignment of its own.

public BucketAlignment Alignment { get; set; }

Property Value​

BucketAlignment

StoredFunctions​

The aggregation functions this rung declares (the distinct functions over its aggregation specs). Empty for a base archive, which stores no aggregation.

public IReadOnlyCollection<CkRollupFunction> StoredFunctions { get; set; }

Property Value​

IReadOnlyCollection<CkRollupFunction>

AvailableFrom​

Measured earliest timestamp with data; null when the rung has no coverage.

public Nullable<DateTime> AvailableFrom { get; set; }

Property Value​

Nullable<DateTime>

AvailableTo​

Measured latest timestamp with data; null when the rung has no coverage.

public Nullable<DateTime> AvailableTo { get; set; }

Property Value​

Nullable<DateTime>

Constructors​

ArchiveCoverageRung(OctoObjectId, String, Boolean, CkArchiveStatus, Nullable<Int64>, BucketAlignment, IReadOnlyCollection<CkRollupFunction>, Nullable<DateTime>, Nullable<DateTime>)​

One rung of an archive family with its measured coverage (AB#5157) — the projection behind the coverageFor GraphQL query, the REST coverage endpoint and the MCP coverage tool.

public ArchiveCoverageRung(OctoObjectId ArchiveRtId, string RtWellKnownName, bool IsBase, CkArchiveStatus Status, Nullable<long> BucketSizeMs, BucketAlignment Alignment, IReadOnlyCollection<CkRollupFunction> StoredFunctions, Nullable<DateTime> AvailableFrom, Nullable<DateTime> AvailableTo)

Parameters​

ArchiveRtId OctoObjectId
Runtime id of the archive this rung describes.

RtWellKnownName String
Optional human-readable name; null falls back to the rtId.

IsBase Boolean
True when the rung is not a rollup — i.e. the raw or time-range archive the family is keyed by. The base takes part in the resolver's coverage filter like any other rung.

Status CkArchiveStatus
The rung's archive lifecycle status, so a client can tell a disabled rung from an empty one.

BucketSizeMs Nullable<Int64>
The rung's native bucket width in milliseconds — a rollup's BucketSize, a time-range base archive's Period, and null for a raw base archive (no declared grain).

Alignment BucketAlignment
Bucket-boundary alignment of the rung; BucketAlignment.FixedSize for a base archive, which has no calendar alignment of its own.

StoredFunctions IReadOnlyCollection<CkRollupFunction>
The aggregation functions this rung declares (the distinct functions over its aggregation specs). Empty for a base archive, which stores no aggregation.

AvailableFrom Nullable<DateTime>
Measured earliest timestamp with data; null when the rung has no coverage.

AvailableTo Nullable<DateTime>
Measured latest timestamp with data; null when the rung has no coverage.