final class ZScheduleClient extends AnyRef

Represents Temporal schedule client

See also

ScheduleClient

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZScheduleClient
  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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. def createSchedule(scheduleId: String, schedule: ZSchedule, options: ZScheduleOptions = ZScheduleOptions.default): TemporalIO[ZScheduleHandle]

    Create a schedule and return its handle.

    Create a schedule and return its handle.

    scheduleId

    Unique ID for the schedule.

    schedule

    Schedule to create.

    options

    Options for creating the schedule.

    returns

    A handle that can be used to perform operations on a schedule.

    Exceptions thrown

    ScheduleAlreadyRunningException if the schedule is already running.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def getHandle(scheduleId: String): TemporalIO[ZScheduleHandle]

    Gets the schedule handle for the given ID.

    Gets the schedule handle for the given ID.

    scheduleId

    Schedule ID to get the handle for.

    returns

    A handle that can be used to perform operations on a schedule.

  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def listSchedules(pageSize: Option[Int] = None): Stream[Throwable, ZScheduleListDescription]

    List schedules.

    List schedules.

    pageSize

    how many results to fetch from the Server at a time. Optional, default is 100.

    returns

    sequential stream that performs remote pagination under the hood

  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def newScheduleStartWorkflowStub[A](options: ZWorkflowOptions, header: Header = Header.empty())(implicit arg0: ClassTag[A], arg1: IsWorkflow[A]): ZScheduleStartWorkflowStub.Of[A]

    Creates new typed schedule start workflow stub builder.

    Creates new typed schedule start workflow stub builder. The instance could then be used to start a scheduled workflow.

    A

    workflow interface

    options

    options that will be used to configure and start a new workflow.

    header

    headers sent with each workflow scheduled

    returns

    builder instance

  16. def newUntypedScheduleStartWorkflowStub(workflowType: String, options: ZWorkflowOptions, header: Header = Header.empty()): Untyped

    Creates new untyped schedule start workflow stub builder.

    Creates new untyped schedule start workflow stub builder. The instance could then be used to start a scheduled workflow.

    workflowType

    workflow type

    options

    options that will be used to configure and start a new workflow.

    header

    headers sent with each workflow scheduled

    returns

    builder instance

  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. val toJava: ScheduleClient
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. 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