ores.scheduler Messaging Reference

Table of Contents

NATS messaging reference for ores.scheduler. All subjects use the scheduler.v1.> namespace, except the generic history read. See ores.nats for transport details.

The entity subjects below are declared by the entity model projects/ores.scheduler/modeling/ores.scheduler.job_definition.org and generated into ores.scheduler.api/messaging/job_definition_protocol.hpp. The operational views are declared by the operation model modeling/ores.scheduler.scheduling_operations.org. A subject is listed here once, and code refers to the generated constant rather than the literal.

1. Job definitions

The canonical entity protocol: read, write, and version reads.

Subject Description
scheduler.v1.job_definitions.list List the current job definitions of the caller's tenant, paged and ordered
scheduler.v1.job_definitions.get Read one current job definition by its identifier
scheduler.v1.job_definitions.get_many Read several current job definitions by identifier
scheduler.v1.job_definitions.put Create or update one job definition, stating a change reason and a precondition
scheduler.v1.job_definitions.put_many Create or update several job definitions in one request
scheduler.v1.job_definitions.delete Remove one job definition, stating a change reason
scheduler.v1.job_definitions.delete_many Remove several job definitions in one request
scheduler.v1.job_definitions_versions.list List the stored versions of one job definition, filtered by version range
scheduler.v1.job_definitions_versions.get Read one stored version of a job definition

2. Job definition change events

Published when a job definition changes, one subject per action.

Subject Description
scheduler.v1.job_definitions_events.created A job definition was created
scheduler.v1.job_definitions_events.updated A job definition was updated
scheduler.v1.job_definitions_events.deleted A job definition was removed

3. Job definition history

The generic history read, served by the component's history provider registrar. The request names the entity as ores.scheduler.job_definition.

Subject Description
history.v1.get Read the change history of a job definition through the shared history handler

4. Operational views

Computed views rather than stored rows, declared by the operation model and served by hand-written handlers.

Subject Description
scheduler.v1.job-instances.list List job executions across every job the caller can see, with the job's name folded in
scheduler.v1.status The live status of every job: its schedule, its last run, its next fire time, and the running total

5. Execution events

Published by the scheduler loop as it fires jobs. Nothing in the tree subscribes to this subject today; the payload is the shared eventing::domain::entity_change_event.

Subject Description
scheduler.v1.job-instance-events A job execution changed state

6. Useful Pages