Struct ScheduleHandle

pub struct ScheduleHandle<C = Channel> { /* private fields */ }

A handle to a schedule.

Implementations

impl<C> ScheduleHandle<C>

where C: GrpcService<BoxBody> + Clone + Send + Sync + 'static, <C as GrpcService<BoxBody>>::Future: Send, C::Error: Into<StdError>, C::ResponseBody: Body<Data = Bytes> + Send + 'static, <C::ResponseBody as Body>::Error: Into<StdError> + Send,

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<(), C>, 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<(), C>>, 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.

Trait Implementations

impl<C: Clone> Clone for ScheduleHandle<C>

fn clone(&self) -> ScheduleHandle<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for ScheduleHandle<C>

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

Formats the value using the given formatter.