Struct ScheduleHandle 

pub struct ScheduleHandle<CT> { /* private fields */ }

Handle to an existing schedule. Obtained from Client::create_schedule or Client::get_schedule_handle.

Implementations

impl<CT> ScheduleHandle<CT>

where CT: WorkflowService + NamespacedClient + Clone + Send + Sync,

pub fn namespace(&self) -> &str

The namespace the schedule belongs to.

pub fn schedule_id(&self) -> &str

The schedule ID.

pub async fn describe(&self) -> Result<ScheduleDescription, ScheduleError>

Describe this schedule, returning its full definition, info, and conflict token.

pub async fn update( &self, updater: impl FnOnce(&mut ScheduleUpdate), ) -> Result<(), ScheduleError>

Update the schedule definition.

Describes the current schedule, applies the closure to modify it, and sends the update. The conflict token is managed automatically.

handle.update(|u| {
    u.set_note("updated").set_paused(true);
}).await?;

pub async fn send_update( &self, update: ScheduleUpdate, ) -> Result<(), ScheduleError>

Send a pre-built ScheduleUpdate to the server.

Prefer update() for most use cases. Use this when you need to inspect the ScheduleDescription before deciding what to change.

pub async fn delete(&self) -> Result<(), ScheduleError>

Delete this schedule.

pub async fn pause( &self, note: Option<impl Into<String>>, ) -> Result<(), ScheduleError>

Pause the schedule with an optional note.

If note is None, a default note is used.

pub async fn unpause( &self, note: Option<impl Into<String>>, ) -> Result<(), ScheduleError>

Unpause the schedule with an optional note.

If note is None, a default note is used.

pub async fn trigger( &self, overlap_policy: ScheduleOverlapPolicy, ) -> Result<(), ScheduleError>

Trigger the schedule to run immediately with the given overlap policy.

pub async fn backfill( &self, backfills: impl IntoIterator<Item = ScheduleBackfill>, ) -> Result<(), ScheduleError>

Request backfill of missed runs.

Trait Implementations

impl<CT: Clone> Clone for ScheduleHandle<CT>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<CT> Debug for ScheduleHandle<CT>

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

Formats the value using the given formatter.