Skip to main content

RollupArchiveInfoDto

Namespace: Meshmakers.Octo.Sdk.ServiceClient.AssetRepositoryServices.StreamData

SDK projection of one rollup archive returned by IStreamDataServicesClient.ListRollupsForArchiveAsync(String, String). Mirrors the asset-repo REST payload exactly so the SDK layer is a thin transport. Rollup-archives concept §9.

public record RollupArchiveInfoDto : IEquatable<RollupArchiveInfoDto>

Inheritance Object → RollupArchiveInfoDto
Implements IEquatable<RollupArchiveInfoDto>

Properties​

RtId​

Runtime id of the rollup archive (string form of OctoObjectId).

public string RtId { get; set; }

Property Value​

String

RtWellKnownName​

Optional well-known name.

public string RtWellKnownName { get; set; }

Property Value​

String

Status​

Lifecycle status — Created / Activated / Disabled / Failed.

public string Status { get; set; }

Property Value​

String

SourceArchiveRtId​

Runtime id of the single source archive this rollup aggregates from. Deprecated since System.StreamData 1.8.0 (AB#5157): the server populates it only when the rollup has exactly one source and that source is unbounded; it is null for every multi-source or span-bounded rollup. Read RollupArchiveInfoDto.Sources instead.

public string SourceArchiveRtId { get; set; }

Property Value​

String

BucketSizeMs​

Bucket width in milliseconds.

public long BucketSizeMs { get; set; }

Property Value​

Int64

WatermarkLagMs​

Watermark lag in milliseconds.

public long WatermarkLagMs { get; set; }

Property Value​

Int64

LastAggregatedBucketEnd​

Exclusive end timestamp of the most recently committed bucket; null before the first tick.

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

Property Value​

Nullable<DateTime>

FrozenUntil​

Upper bound of the frozen range; null when not frozen.

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

Property Value​

Nullable<DateTime>

AggregationCount​

Number of aggregation specs configured on this rollup.

public int AggregationCount { get; set; }

Property Value​

Int32

RecomputeInProgress​

True while a recompute job for this rollup is running or swapping (AB#4184).

public bool RecomputeInProgress { get; set; }

Property Value​

Boolean

LastRecomputeStartedAt​

Start timestamp of the most recent recompute run; null before the first run.

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

Property Value​

Nullable<DateTime>

LastRecomputeSuccessAt​

Finish timestamp of the most recent successfully committed recompute run; null before the first success.

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

Property Value​

Nullable<DateTime>

LastRecomputeFailureAt​

Timestamp of the most recent failed recompute run; null if the last run succeeded.

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

Property Value​

Nullable<DateTime>

LastRecomputeFailureReason​

Human-readable reason for the most recent recompute failure; null if the last run succeeded.

public string LastRecomputeFailureReason { get; set; }

Property Value​

String

DirtyWindowsPending​

Number of dirty windows recorded on this archive (retroactive changes not yet propagated); 0 in the steady state.

public int DirtyWindowsPending { get; set; }

Property Value​

Int32

PendingRecomputeRanges​

Number of pending recompute ranges queued on this archive (the recompute work list still to drain); 0 in the steady state.

public int PendingRecomputeRanges { get; set; }

Property Value​

Int32

Sources​

The normalised, time-disjoint source archives this rollup aggregates from (AB#5157). null when the server predates System.StreamData 1.8.0 and reported only RollupArchiveInfoDto.SourceArchiveRtId.

public IReadOnlyList<RollupSourceReferenceDto> Sources { get; set; }

Property Value​

IReadOnlyList<RollupSourceReferenceDto>

Remarks:

Deliberately an init property rather than a positional parameter: appending one to the primary constructor would change this record's Deconstruct signature, which is source-breaking for consumers even though the parameter is optional. The addition is meant to be purely additive.

Constructors​

RollupArchiveInfoDto(String, String, String, String, Int64, Int64, Nullable<DateTime>, Nullable<DateTime>, Int32, Boolean, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, String, Int32, Int32)​

SDK projection of one rollup archive returned by IStreamDataServicesClient.ListRollupsForArchiveAsync(String, String). Mirrors the asset-repo REST payload exactly so the SDK layer is a thin transport. Rollup-archives concept §9.

public RollupArchiveInfoDto(string RtId, string RtWellKnownName, string Status, string SourceArchiveRtId, long BucketSizeMs, long WatermarkLagMs, Nullable<DateTime> LastAggregatedBucketEnd, Nullable<DateTime> FrozenUntil, int AggregationCount, bool RecomputeInProgress, Nullable<DateTime> LastRecomputeStartedAt, Nullable<DateTime> LastRecomputeSuccessAt, Nullable<DateTime> LastRecomputeFailureAt, string LastRecomputeFailureReason, int DirtyWindowsPending, int PendingRecomputeRanges)

Parameters​

RtId String
Runtime id of the rollup archive (string form of OctoObjectId).

RtWellKnownName String
Optional well-known name.

Status String
Lifecycle status — Created / Activated / Disabled / Failed.

SourceArchiveRtId String
Runtime id of the single source archive this rollup aggregates from. Deprecated since System.StreamData 1.8.0 (AB#5157): the server populates it only when the rollup has exactly one source and that source is unbounded; it is null for every multi-source or span-bounded rollup. Read RollupArchiveInfoDto.Sources instead.

BucketSizeMs Int64
Bucket width in milliseconds.

WatermarkLagMs Int64
Watermark lag in milliseconds.

LastAggregatedBucketEnd Nullable<DateTime>
Exclusive end timestamp of the most recently committed bucket; null before the first tick.

FrozenUntil Nullable<DateTime>
Upper bound of the frozen range; null when not frozen.

AggregationCount Int32
Number of aggregation specs configured on this rollup.

RecomputeInProgress Boolean
True while a recompute job for this rollup is running or swapping (AB#4184).

LastRecomputeStartedAt Nullable<DateTime>
Start timestamp of the most recent recompute run; null before the first run.

LastRecomputeSuccessAt Nullable<DateTime>
Finish timestamp of the most recent successfully committed recompute run; null before the first success.

LastRecomputeFailureAt Nullable<DateTime>
Timestamp of the most recent failed recompute run; null if the last run succeeded.

LastRecomputeFailureReason String
Human-readable reason for the most recent recompute failure; null if the last run succeeded.

DirtyWindowsPending Int32
Number of dirty windows recorded on this archive (retroactive changes not yet propagated); 0 in the steady state.

PendingRecomputeRanges Int32
Number of pending recompute ranges queued on this archive (the recompute work list still to drain); 0 in the steady state.