BuiltInQueryModelProfile

The profile of an aggregate's read model, Snapshot or EventStream: every record carries an identity, a payload, an event time and every system field, the record metadata shared by both models.

Inheritors

Properties

Link copied to clipboard
abstract override val eventTimeField: QueryField

When the record last changed: the default orderBy of FIRST and LAST metrics; null when there is none.

Link copied to clipboard
abstract override val identityField: QueryField

Unique record identity: the target of id filters and the tie-breaker of every cursor; null when the model declares none, which rejects both.

Link copied to clipboard
abstract override val payloadField: QueryField

Logical field that holds the user payload; masked fields and schema extensions must live below it. null when the whole record is payload, as in a dataset.

Link copied to clipboard

The field an authenticated caller scope must pin when requireAuthenticatedScope is on: the tenant, the isolation boundary of every built-in model.

Functions

Link copied to clipboard
override fun systemField(field: SystemField): QueryField

The logical field a system-field filter (ID, TENANT_ID, DELETION, ...) targets: identityField for the record identity; null when the model does not carry field.