c

zio.temporal.schedules

ZScheduleHandle

final class ZScheduleHandle extends AnyRef

Handle for interacting with a schedule.

See also

ScheduleHandle

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZScheduleHandle
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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.

    backfills

    backfill requests to run

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def delete(): TemporalIO[Unit]

    Delete this schedule.

  8. def describe: TemporalIO[ZScheduleDescription]

    Fetch this schedule's description.

    Fetch this schedule's description.

    returns

    description of the schedule

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def id: String

    Get this schedule's ID.

    Get this schedule's ID.

    returns

    the schedule's ID

  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. def pause(note: Option[String] = None): TemporalIO[Unit]

    Pause this schedule.

    Pause this schedule.

    note

    to set the schedule state.

  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. val toJava: ScheduleHandle
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. def trigger(overlapPolicy: Option[ScheduleOverlapPolicy] = None): TemporalIO[Unit]

    Trigger an action on this schedule to happen immediately.

    Trigger an action on this schedule to happen immediately.

    overlapPolicy

    override the schedule overlap policy.

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

    Unpause this schedule.

    Unpause this schedule.

    note

    to set the schedule state.

  24. def update(updater: (ZScheduleUpdateInput) => ZScheduleUpdate): TemporalIO[Unit]

    Update this schedule.

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

    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.

  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped