Untyped

zio.temporal.workflow.ZWorkflowStub$.Untyped
sealed trait Untyped

An untyped version of ZWorkflowStub

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

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.

Attributes

Throws
WorkflowNotFoundException

if the workflow execution doesn't exist or is already completed

WorkflowServiceException

for all other failures including networking and service availability issues

def query[R : JavaTypeTag](queryType: String, args: Any*): TemporalIO[R]

Synchronously queries workflow by invoking its query handler. Usually a query handler is a method annotated with zio.temporal.queryMethod.

Synchronously queries workflow by invoking its query handler. Usually a query handler is a method annotated with zio.temporal.queryMethod.

Type parameters

R

type of the query result

Value parameters

args

optional query arguments

queryType

name of the query handler. Usually it is a method name.

Attributes

Returns

query result

Throws
WorkflowNotFoundException

if the workflow execution doesn't exist

WorkflowQueryException

if the query failed during it's execution by the workflow worker or was rejected on any stage

WorkflowServiceException

for all other failures including networking and service availability issues

Fetches workflow result

Fetches workflow result

Type parameters

V

expected workflow result type

Attributes

Returns

either interaction error or the workflow result

def result[V : JavaTypeTag](timeout: Duration): TemporalIO[Option[V]]
def signal(signalName: String, args: Any*): TemporalIO[Unit]

Synchronously signals a workflow by invoking its signal handler. Usually a signal handler is a method annotated with zio.temporal.signalMethod.

Synchronously signals a workflow by invoking its signal handler. Usually a signal handler is a method annotated with zio.temporal.signalMethod.

Value parameters

args

signal method arguments

signalName

name of the signal handler. Usually it is a method name.

Attributes

Throws
WorkflowNotFoundException

if the workflow execution doesn't exist or completed and can't be signalled

WorkflowServiceException

for all other failures including networking and service availability issues

def signalWithStart(signalName: String, signalArgs: Seq[Any], startArgs: Seq[Any]): TemporalIO[ZWorkflowExecution]
def start(args: Any*): TemporalIO[ZWorkflowExecution]
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.

Value parameters

details

additional details about the termination reason

reason

optional reason for the termination request

Attributes

Throws
WorkflowNotFoundException

if the workflow execution doesn't exist or is already completed

WorkflowServiceException

for all other failures including networking and service availability issues

def toJava: WorkflowStub

Concrete methods

def execute[V : JavaTypeTag](args: Any*): TemporalIO[V]
def executeWithTimeout[V : JavaTypeTag](timeout: Duration, args: Any*): TemporalIO[Option[V]]