ZScheduleHandle

zio.temporal.schedules.ZScheduleHandle
final class ZScheduleHandle

Handle for interacting with a schedule.

Attributes

See also

ScheduleHandle

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def backfill(backfills: List[ZScheduleBackfill]): TemporalIO[Unit]

Backfill this schedule by going through the specified time periods as if they passed right now.

Backfill this schedule by going through the specified time periods as if they passed right now.

Value parameters

backfills

backfill requests to run

Attributes

def delete(): TemporalIO[Unit]

Delete this schedule.

Delete this schedule.

Attributes

Fetch this schedule's description.

Fetch this schedule's description.

Attributes

Returns

description of the schedule

def id: String

Get this schedule's ID.

Get this schedule's ID.

Attributes

Returns

the schedule's ID

def pause(note: Option[String] = ...): TemporalIO[Unit]

Pause this schedule.

Pause this schedule.

Value parameters

note

to set the schedule state.

Attributes

def trigger(overlapPolicy: Option[ScheduleOverlapPolicy] = ...): TemporalIO[Unit]

Trigger an action on this schedule to happen immediately.

Trigger an action on this schedule to happen immediately.

Value parameters

overlapPolicy

override the schedule overlap policy.

Attributes

def unpause(note: Option[String] = ...): TemporalIO[Unit]

Unpause this schedule.

Unpause this schedule.

Value parameters

note

to set the schedule state.

Attributes

Update this schedule. This is done via a callback which can be called multiple times in case of conflict.

Update this schedule. This is done via a callback which can be called multiple times in case of conflict.

Value parameters

updater

Callback to invoke with the current update input. The result can be null to signify no update to perform, or a schedule update instance with a schedule to perform an update.

Attributes

Concrete fields

val toJava: ScheduleHandle