ZIO Temporal
v1.0.0-RC3
API
Generated with
ZIO Temporal/zio.temporal/zio.temporal.workflow/ZWorkflowStubImpl

ZWorkflowStubImpl

zio.temporal.workflow.ZWorkflowStubImpl
final class ZWorkflowStubImpl(val toJava: WorkflowStub, val stubbedClass: Class[_]) extends ZWorkflowStub

Represents untyped workflow stub

Attributes

See also

WorkflowStub

Graph
Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Inherited 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
io.temporal.client.WorkflowNotFoundException

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

io.temporal.client.WorkflowServiceException

for all other failures including networking and service availability issues

Inherited from:
ZWorkflowStub
def options: Option[ZWorkflowOptions]

Attributes

Returns

None if the stub is created to bound to an existing execution.

Inherited from:
ZWorkflowStub
def result[V : ZTemporalCodec](timeout: Duration): TemporalIO[Option[V]]

Attributes

Inherited from:
ZWorkflowStub
def result[V : ZTemporalCodec]: TemporalIO[V]

Fetches workflow result

Fetches workflow result

Type parameters

V

expected workflow result type

Attributes

Returns

either interaction error or the workflow result

Inherited from:
ZWorkflowStub
inline def signalWithStart(inline start: Unit, inline signal: Unit): TemporalIO[ZWorkflowExecution]

Performs signal with start atomically.

Performs signal with start atomically.

Value parameters

signal

signal method call

start

workflow method call

Attributes

Returns

Workflow execution

Inherited from:
ZWorkflowClientSignalWithStartSyntax
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
io.temporal.client.WorkflowNotFoundException

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

io.temporal.client.WorkflowServiceException

for all other failures including networking and service availability issues

Inherited from:
ZWorkflowStub

Concrete fields

val stubbedClass: Class[_]

Retrieves the runtime class of a stubbed type

Retrieves the runtime class of a stubbed type

Attributes

val toJava: WorkflowStub
override val untyped: Untyped

Returns an untyped version of ZWorkflowStub

Returns an untyped version of ZWorkflowStub

Attributes

Generated with