zio-temporal-core/zio.temporal.workflow/ZWorkflowStub

ZWorkflowStub

zio.temporal.workflow.ZWorkflowStub

See theZWorkflowStub companion object

sealed trait ZWorkflowStub extends ZWorkflowClientSignalWithStartSyntax

Attributes

Companion:: object
Graph
Supertypes: trait ZWorkflowClientSignalWithStartSyntax
class Object
trait Matchable
class Any
Known subtypes: class ZWorkflowStubImpl

Members list

Concise view

Value members

Abstract methods

Concrete methods

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

Fetches workflow result

Attributes

V: expected workflow result type
Returns:: either interaction error or the workflow result

Terminates a workflow execution.

Termination is a hard stop of a workflow execution which doesn't give workflow code any chance to perform cleanup.

Attributes

details: additional details about the termination reason
reason: optional reason for the termination request
Throws:: WorkflowNotFoundException
if the workflow execution doesn't exist or is already completed

WorkflowServiceException
for all other failures including networking and service availability issues

Inherited methods

Performs signal with start atomically.

Attributes

signal: signal method call
start: workflow method call
Returns:: Workflow execution
Inherited from:: ZWorkflowClientSignalWithStartSyntax

Generated with