Orleans.Lattice.Api.Abstractions 9.9.0

Orleans.Lattice.Api.Abstractions

Shared contract package for the Orleans.Lattice API facades. It holds the transport-agnostic service interfaces, their request / response models and the typed exceptions they document, and nothing else - no implementation, no registration, no background work.

Design

The API facades (Orleans.Lattice.Api.State, .Api.Data, .Api.Auth, .Api.Backup, .Api.Schema, .Api.Replication, .Api.Telemetry, .Api.TreeAdmin, .Api.TenantAdmin, and .Api.Apps) each expose a transport-agnostic service surface that a transport binding projects onto a wire protocol. Two families of package consume those surfaces: the code-first gRPC bindings and the Orleans.Lattice.Api.Mcp server.

This package is the seam between them. It carries:

• The service interfaces - ILatticeStateQuery, ILatticeStateObserver, ILatticeStateMetricsObserver, ILatticeDataApi, ILatticeAuthAdmin, ILatticeBackupControl, ILatticeBackupOperations, ILatticeSchemaControl, ILatticeReplicationControl, ILatticeReplicationStatus, ILatticeTelemetry, ILatticeTreeAdmin, ILatticeTenantAdmin, ILatticeTenantAccessAdmin, ILatticeTenantGrantAdmin, ILatticeTenantQuotaUsage, ILatticeTenantRegionAdmin, ILatticeTenantSelfService, the installable-app ILatticeAppsControl, ILatticeAppRoleBindings, ILatticeAppCatalog, ILatticeAppWorkspace and ILatticeAppBridge, and the region-discovery ILatticeRegionCatalog.
• Their request / response models - the results, pages, records, and requests those interfaces exchange, with their stable Orleans serialization aliases.
• Shared operation tracking - Orleans.Lattice.Api.Operations provides the accept-then-poll handle, status, list-page, and cancel contract used by backup and future long-running facades. Backup's blocking verbs are deprecated and will be removed in the next major version; migrate at https://nsta1.github.io/Orleans.Lattice/docs/lattice.api.backup/operations.html#migrating-from-the-blocking-verbs.

The facade packages reference this package and implement the interfaces; the binding packages reference this package and consume them. Publishing the contract as a real, versioned public surface keeps internal meaning "safe to change" inside each facade, and lets a binding evolve against a stable contract rather than another package's internals.

Usage

You do not register anything from this package directly. Register a facade (which implements these contracts) and a binding (which consumes them):

builder.Host.UseOrleans(silo => silo
    .AddLattice(/* ... */)
    .AddLatticeStateApi());                // implements ILatticeStateQuery

builder.Services.AddLatticeStateApiGrpc(); // binds a gRPC surface over it
// ... app build ...
app.MapLatticeStateApiGrpc();