Struct ScheduleUpdate 

pub struct ScheduleUpdate { /* private fields */ }

An update to apply to a schedule definition.

Obtain from ScheduleDescription::into_update(), modify the schedule using the setter methods, then pass to ScheduleHandle::update().

Implementations

impl ScheduleUpdate

pub fn set_spec(&mut self, spec: ScheduleSpec) -> &mut Self

Replace the schedule spec (when to trigger).

pub fn set_action(&mut self, action: ScheduleAction) -> &mut Self

Replace the schedule action (what to do on trigger).

pub fn set_paused(&mut self, paused: bool) -> &mut Self

Set whether the schedule is paused.

pub fn set_note(&mut self, note: impl Into<String>) -> &mut Self

Set the note on the schedule state.

pub fn set_overlap_policy(&mut self, policy: ScheduleOverlapPolicy) -> &mut Self

Set the overlap policy.

pub fn set_catchup_window(&mut self, window: Duration) -> &mut Self

Set the catchup window. Actions missed by more than this duration are skipped.

pub fn set_pause_on_failure(&mut self, pause_on_failure: bool) -> &mut Self

Set whether to pause the schedule when a workflow run fails or times out.

pub fn set_keep_original_workflow_id(&mut self, keep: bool) -> &mut Self

Set whether to keep the original workflow ID without appending a timestamp.

pub fn set_remaining_actions(&mut self, count: Option<i64>) -> &mut Self

Limit the schedule to a fixed number of remaining actions, after which it stops triggering. Passing None removes the limit.

pub fn raw(&self) -> &Schedule

Access the raw schedule proto.

pub fn into_raw(self) -> Schedule

Consume and return the raw schedule proto.

Trait Implementations

impl Clone for ScheduleUpdate

fn clone(&self) -> ScheduleUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduleUpdate

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

Formats the value using the given formatter.