Skip to main content

ArchiveCoverageDto

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

SDK projection of the measured data coverage of one archive in a tenant's stream-data landscape (AB#5157), returned by IStreamDataServicesClient.GetArchiveCoverageAsync(String, String). Mirrors the asset-repo REST payload exactly so the SDK layer stays a thin transport; every enum-valued member travels as its PascalCase name.

public record ArchiveCoverageDto : IEquatable<ArchiveCoverageDto>

Inheritance Object → ArchiveCoverageDto
Implements IEquatable<ArchiveCoverageDto>

Properties​

ArchiveRtId​

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

public string ArchiveRtId { get; set; }

Property Value​

String

RtWellKnownName​

Optional well-known name of the archive.

public string RtWellKnownName { get; set; }

Property Value​

String

IsBase​

True when the archive is not a rollup, i.e. it is written to directly.

public bool IsBase { get; set; }

Property Value​

Boolean

Status​

Lifecycle status — Created / Activated / Disabled / Failed.

public string Status { get; set; }

Property Value​

String

BucketSizeMs​

Bucket width in milliseconds; null for a raw base archive, which has no buckets.

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

Property Value​

Nullable<Int64>

BucketAlignment​

Bucket alignment as its enum name — FixedSize / CalendarDay / Iso8601Week / CalendarMonth / CalendarQuarter / CalendarYear; a base archive reports FixedSize.

public string BucketAlignment { get; set; }

Property Value​

String

StoredFunctions​

Aggregation functions the rollup declares, as enum names; empty (or null) for a base archive.

public IReadOnlyList<string> StoredFunctions { get; set; }

Property Value​

IReadOnlyList<String>

AvailableFrom​

Timestamp of the earliest stored row; null when the archive holds no data.

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

Property Value​

Nullable<DateTime>

AvailableTo​

Timestamp of the latest stored row; null when the archive holds no data.

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

Property Value​

Nullable<DateTime>

Constructors​

ArchiveCoverageDto(String, String, Boolean, String, Nullable<Int64>, String, IReadOnlyList<String>, Nullable<DateTime>, Nullable<DateTime>)​

SDK projection of the measured data coverage of one archive in a tenant's stream-data landscape (AB#5157), returned by IStreamDataServicesClient.GetArchiveCoverageAsync(String, String). Mirrors the asset-repo REST payload exactly so the SDK layer stays a thin transport; every enum-valued member travels as its PascalCase name.

public ArchiveCoverageDto(string ArchiveRtId, string RtWellKnownName, bool IsBase, string Status, Nullable<long> BucketSizeMs, string BucketAlignment, IReadOnlyList<string> StoredFunctions, Nullable<DateTime> AvailableFrom, Nullable<DateTime> AvailableTo)

Parameters​

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

RtWellKnownName String
Optional well-known name of the archive.

IsBase Boolean
True when the archive is not a rollup, i.e. it is written to directly.

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

BucketSizeMs Nullable<Int64>
Bucket width in milliseconds; null for a raw base archive, which has no buckets.

BucketAlignment String
Bucket alignment as its enum name — FixedSize / CalendarDay / Iso8601Week / CalendarMonth / CalendarQuarter / CalendarYear; a base archive reports FixedSize.

StoredFunctions IReadOnlyList<String>
Aggregation functions the rollup declares, as enum names; empty (or null) for a base archive.

AvailableFrom Nullable<DateTime>
Timestamp of the earliest stored row; null when the archive holds no data.

AvailableTo Nullable<DateTime>
Timestamp of the latest stored row; null when the archive holds no data.