Interface OfflineRegionMetadataReadV1

A metadata document, plus its parsed form when it declares a JSON media type.

interface OfflineRegionMetadataReadV1 {
    attribution: Readonly<Record<string, string>>;
    bytes: Uint8Array;
    cache: OfflineRegionReadCacheDecisionV1;
    contentType?: string;
    degraded: readonly DegradedReason[];
    document?: unknown;
    kind: "honua.offline-region-read";
    planCache: QueryPlanCacheOptions;
    provenance: OfflineRegionReadProvenanceV1;
    regionId: `sha256:${string}`;
    resourceId: string;
    resourceKind: "metadata";
    version: "1.0";
}

Hierarchy (view full)

Properties

attribution bytes cache contentType? degraded document? kind planCache provenance regionId resourceId resourceKind version

Properties

Readonlyattribution

attribution: Readonly<Record<string, string>>

Readonlybytes

bytes: Uint8Array

Caller-owned bytes exactly as they were persisted; never re-encoded.

Readonlycache

cache: OfflineRegionReadCacheDecisionV1

Optional ReadonlycontentType

contentType?: string

Readonlydegraded

degraded: readonly DegradedReason[]

Same never-silently-live discipline a Result carries, in the same vocabulary. A binary read has no Result to stamp, so the degradation travels here.

Optional Readonlydocument

document?: unknown

Present only for a JSON media type; a non-JSON document stays bytes.

Readonlykind

kind

ReadonlyplanCache

planCache: QueryPlanCacheOptions

Readonlyprovenance

provenance: OfflineRegionReadProvenanceV1

ReadonlyregionId

regionId: `sha256:${string}`

ReadonlyresourceId

resourceId: string

ReadonlyresourceKind

resourceKind

Readonlyversion

version

Settings

Member Visibility

On This Page

Properties