Struct ScheduleHandle

pub struct ScheduleHandle { /* private fields */ }

A handle to a schedule.

Implementations

impl ScheduleHandle

pub fn id(&self) -> Uuid

Get the ID of the schedule.

pub async fn details(&self) -> Result<Arc<ScheduleDetails>>

Get the details of the schedule.

pub fn cached_details(&self) -> Option<Arc<ScheduleDetails>>

Get the cached details of the schedule, if available.

pub fn jobs( &self, filter: JobFilter, order: JobOrder, ) -> impl Stream<Item = Result<JobHandle, AdminClientError>> + Send + Unpin + 'static

Get the jobs that were created by this schedule with the given filter and order.

pub async fn job_count(&self) -> Result<u64, AdminClientError>

Return the amount of jobs that were created by this schedule.

pub async fn active_job(&self) -> Result<Option<JobHandle>, AdminClientError>

Get the active job of the schedule.

pub async fn cancel(&self, cancel_jobs: bool) -> Result<(), AdminClientError>

Cancel the schedule, optionally cancelling all jobs created by the schedule.