Interface: StreamRule
Defined in: packages/contracts/src/permissions/table.ts:432
A JetStream stream capturing event contracts that must not be lost.
Properties
captures
readonlycaptures: readonly ("request.platform.identity.principal.resolve.v1"|"request.platform.identity.me.get.v1"|"request.*.identity.subject.create.v1"|"request.*.identity.subject.get.v1"|"request.platform.identity.bootstrap.apply.v1"|"request.*.identity.person.create.v1"|"request.*.identity.person.get.v1"|"request.*.identity.person.invite.v1"|"request.*.identity.grant.create.v1"|"request.*.identity.grant.revoke.v1"|"request.*.identity.grant.list.v1"|"event.*.identity.grant.revoked.v1"|"event.*.*.audit.recorded.v1"|"event.platform.gateway.audit.recorded.v1"|"event.platform.gateway-admin.audit.recorded.v1"|"event.platform.bootstrap.audit.recorded.v1"|"request.*.governance.accreditation.apply.v1"|"request.*.governance.accreditation.admit.v1"|"request.*.governance.accreditation.publish.v1"|"request.*.governance.accreditation.get.v1"|"request.*.governance.accreditation.list.v1"|"request.platform.governance.anchor.converge.v1"|"event.*.governance.accreditation.admitted.v1"|"event.*.governance.accreditation.publication-approved.v1"|"request.*.trust.entity-statement.list.v1"|"request.*.trust.entity-statement.preview.v1"|"event.*.trust.entity-statement.published.v1"|"request.*.issuance.identifier.create.v1"|"request.*.issuance.identifier.get.v1"|"request.*.issuance.identifier.list.v1"|"request.*.issuance.identifier.preview.v1"|"request.*.issuance.identifier.publish.v1"|"request.*.issuance.identifier.update.v1"|"request.platform.provisioning.agent.converge.v1"|"request.platform.issuance.registry.probe.v1"|"request.platform.issuance.identifier.converge.v1"|"request.platform.trust.key-store.probe.v1"|"request.platform.issuance.identifier.resolve.v1"|"request.platform.identity.root-sign-in.get.v1"|"event.*.issuance.identifier.requested.v1"|"event.*.provisioning.placement.changed.v1"|"event.*.issuance.identifier.published.v1")[]
Defined in: packages/contracts/src/permissions/table.ts:434
The event contracts it captures.
consumers
readonlyconsumers: readonlyStreamConsumer[]
Defined in: packages/contracts/src/permissions/table.ts:436
Its durable consumers.
retention?
readonlyoptionalretention?:"limits"|"work-queue"
Defined in: packages/contracts/src/permissions/table.ts:451
How long a message stays; see STREAM_RETENTIONS. Absent means limits,
which is what every stream was before the field existed. Read it through
streamRetention, never directly, so the default has one home.
A work-queue stream must have exactly the readers JetStream allows it: at least
one consumer, and no two whose filters can match one subject. verifyEstate
refuses anything else, since the broker would refuse it at setup time.
A stream's retention cannot be changed on a live broker. JetStream refuses the update, so changing this field for a stream that exists means removing the stream and declaring it again. That is a decision for whoever operates the broker, not a side effect of a deploy.