sealed trait Untyped extends AnyRef
An untyped version of ZWorkflowStub
- Alphabetic
- By Inheritance
- Untyped
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def cancel: TemporalIO[Unit]
Request cancellation of a workflow execution.
Request cancellation of a workflow execution.
Cancellation cancels io.temporal.workflow.CancellationScope that wraps the main workflow method. Note that workflow can take long time to get canceled or even completely ignore the cancellation request.
- Exceptions thrown
io.temporal.client.WorkflowNotFoundExceptionif the workflow execution doesn't exist or is already completedio.temporal.client.WorkflowServiceExceptionfor all other failures including networking and service availability issues
- abstract def query[R](queryType: String, args: Any*)(implicit arg0: TypeIsSpecified[R], arg1: JavaTypeTag[R]): TemporalIO[R]
Synchronously queries workflow by invoking its query handler.
Synchronously queries workflow by invoking its query handler. Usually a query handler is a method annotated with zio.temporal.queryMethod.
- R
type of the query result
- queryType
name of the query handler. Usually it is a method name.
- args
optional query arguments
- returns
query result
- Exceptions thrown
io.temporal.client.WorkflowNotFoundExceptionif the workflow execution doesn't existio.temporal.client.WorkflowQueryExceptionif the query failed during it's execution by the workflow worker or was rejected on any stageio.temporal.client.WorkflowServiceExceptionfor all other failures including networking and service availability issues
- abstract def result[V](timeout: zio.Duration)(implicit arg0: TypeIsSpecified[V], arg1: JavaTypeTag[V]): TemporalIO[Option[V]]
- abstract def result[V](implicit arg0: TypeIsSpecified[V], arg1: JavaTypeTag[V]): TemporalIO[V]
Fetches workflow result
Fetches workflow result
- V
expected workflow result type
- returns
either interaction error or the workflow result
- abstract def signal(signalName: String, args: Any*): TemporalIO[Unit]
Synchronously signals a workflow by invoking its signal handler.
Synchronously signals a workflow by invoking its signal handler. Usually a signal handler is a method annotated with zio.temporal.signalMethod.
- signalName
name of the signal handler. Usually it is a method name.
- args
signal method arguments
- Exceptions thrown
io.temporal.client.WorkflowNotFoundExceptionif the workflow execution doesn't exist or completed and can't be signalledio.temporal.client.WorkflowServiceExceptionfor all other failures including networking and service availability issues
- abstract def signalWithStart(signalName: String, signalArgs: Seq[Any], startArgs: Seq[Any]): TemporalIO[ZWorkflowExecution]
- abstract def start(args: Any*): TemporalIO[ZWorkflowExecution]
- abstract def terminate(reason: Option[String], details: Any*): TemporalIO[Unit]
Terminates a workflow execution.
Terminates a workflow execution.
Termination is a hard stop of a workflow execution which doesn't give workflow code any chance to perform cleanup.
- reason
optional reason for the termination request
- details
additional details about the termination reason
- Exceptions thrown
io.temporal.client.WorkflowNotFoundExceptionif the workflow execution doesn't exist or is already completedio.temporal.client.WorkflowServiceExceptionfor all other failures including networking and service availability issues
- abstract def toJava: WorkflowStub
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def execute[V](args: Any*)(implicit arg0: TypeIsSpecified[V], arg1: JavaTypeTag[V]): TemporalIO[V]
- def executeWithTimeout[V](timeout: zio.Duration, args: Any*)(implicit arg0: TypeIsSpecified[V], arg1: JavaTypeTag[V]): TemporalIO[Option[V]]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)