Skip to main content

CatalogJobScheduleSpec

Struct CatalogJobScheduleSpec 

Source
pub struct CatalogJobScheduleSpec<'a> {
    pub name: &'a str,
    pub job_type: &'a str,
    pub cron_expr: &'a str,
    pub payload_template: &'a Value,
    pub is_active: bool,
    pub organization_id: Option<Uuid>,
    pub max_jitter_seconds: i32,
    pub next_fire_at: Option<DateTime<Utc>>,
}
Expand description

Catalog-owned cron schedule definition synced to job_schedules at startup.

Specs are validated before database writes. Names and cron expressions must be non-empty without surrounding whitespace, cron expressions must parse as UTC cron schedules, and max_jitter_seconds must be in the inclusive range 0..=JOB_SCHEDULE_MAX_JITTER_SECONDS.

§Example

use runledger_runtime::catalog::CatalogJobScheduleSpec;

let payload = serde_json::json!({ "kind": "refresh" });
let spec = CatalogJobScheduleSpec {
    name: "profiles.refresh.hourly",
    job_type: "profiles.refresh",
    cron_expr: "0 0 * * * *",
    payload_template: &payload,
    is_active: true,
    organization_id: None,
    max_jitter_seconds: 0,
    next_fire_at: None,
};

assert_eq!(spec.name, "profiles.refresh.hourly");

Fields§

§name: &'a str

Unique schedule name. This is the global job_schedules.name key and must be non-empty without surrounding whitespace.

§job_type: &'a str

Catalog job type enqueued when the schedule fires. The job type must be registered and effectively enabled in the super::JobCatalog used for schedule registration or sync.

§cron_expr: &'a str

UTC cron expression without surrounding whitespace.

On conflict, catalog sync preserves the existing next_fire_at cursor when this expression is unchanged. When this expression changes, the synced next_fire_at value becomes the stored cursor.

§payload_template: &'a Value

JSON payload template copied into scheduled jobs.

§is_active: bool

Desired active state after sync. Applications can map feature flags to this value before calling catalog schedule sync.

§organization_id: Option<Uuid>

Optional organization scope copied into jobs for a new schedule.

§max_jitter_seconds: i32

Maximum deterministic jitter, in seconds, applied to future fire times. Must be between 0 and JOB_SCHEDULE_MAX_JITTER_SECONDS, inclusive.

§next_fire_at: Option<DateTime<Utc>>

Next UTC instant at which the schedule is due. Defaults to Utc::now() when unset at sync time.

This value is used for new rows and for existing rows whose cron expression changed. Existing rows with the same cron expression keep their stored cursor.

Trait Implementations§

Source§

impl<'a> Clone for CatalogJobScheduleSpec<'a>

Source§

fn clone(&self) -> CatalogJobScheduleSpec<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for CatalogJobScheduleSpec<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for CatalogJobScheduleSpec<'a>

Source§

impl<'a> PartialEq for CatalogJobScheduleSpec<'a>

Source§

fn eq(&self, other: &CatalogJobScheduleSpec<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> StructuralPartialEq for CatalogJobScheduleSpec<'a>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more