Attributes
- Companion
- trait
- Graph
-
- Supertypes
-
trait ZWorkflowStubQuerySyntaxtrait ZWorkflowExecutionSyntaxclass Objecttrait Matchableclass AnyShow all
- Self type
-
ZWorkflowStub.type
Members list
Type members
Classlikes
Attributes
- Supertypes
-
class AnyValtrait Matchableclass Any
An untyped version of ZWorkflowStub
Inherited types
Stub is a compile-time view of temporal's runtime abstractions, such as Workflows.
Stub is a compile-time view of temporal's runtime abstractions, such as Workflows.
Type parameters
- T
-
compile-time view
Attributes
- Note
-
Do not call methods of proxied workflows directly! It should be used only within special methods like
ZWorkflowStub.signal,ZWorkflowStub.start,ZWorkflowStub.executeand so on. - Inherited from:
- Stubs (hidden)
Value members
Inherited methods
Executes the given workflow. '''Waits''' for the workflow to finish. Accepts the workflow method invocation
Executes the given workflow. '''Waits''' for the workflow to finish. Accepts the workflow method invocation
Example:
val stub: ZWorkflowStub.Of[T] = ???
val workflowExecution: TemporalIO[R] =
ZWorkflowStub.execute(
stub.someMethod(someArg)
)
Type parameters
- R
-
workflow result type
Value parameters
- f
-
the workflow method invocation
Attributes
- Returns
-
the workflow result
- Inherited from:
- ZWorkflowExecutionSyntax
Executes the given workflow with a given timeout. '''Waits''' for the workflow to finish. Accepts the workflow method invocation
Executes the given workflow with a given timeout. '''Waits''' for the workflow to finish. Accepts the workflow method invocation
Example:
val stub: ZWorkflowStub.Of[T] = ???
val workflowExecution: TemporalIO[R] =
ZWorkflowStub.executeWithTimeout(5.seconds)(
stub.someMethod(someArg)
)
Type parameters
- R
-
workflow result type
Value parameters
- f
-
the workflow method invocation
- timeout
-
the timeout
Attributes
- Returns
-
the workflow result
- Inherited from:
- ZWorkflowExecutionSyntax
Queries the given workflow. Accepts the workflow query method invocation
Queries the given workflow. Accepts the workflow query method invocation
Example:
val stub: ZWorkflowStub.Of[T] = ???
val result: TemporalIO[R] = ZWorkflowStub.query(
stub.someQuery()
)
Type parameters
- R
-
query method result type
Value parameters
- f
-
the query method invocation
Attributes
- Returns
-
the query method result
- Inherited from:
- ZWorkflowStubQuerySyntax
Sends a signal to the workflow. Accepts the signal method invocation
Sends a signal to the workflow. Accepts the signal method invocation
Example:
val stub: ZWorkflowStub.Of[T] = ???
val signalSent: TemporalIO[Unit] = ZWorkflowStub.signal(
stub.someSignalMethod(someArg)
)
Value parameters
- f
-
the signal method invocation
Attributes
- Returns
-
ZIO
- Inherited from:
- ZWorkflowStubSignalSyntax
Starts the given workflow. '''Doesn't wait''' for the workflow to finish. Accepts the workflow method invocation
Starts the given workflow. '''Doesn't wait''' for the workflow to finish. Accepts the workflow method invocation
Example:
val stub: ZWorkflowStub.Of[T] = ???
val workflowExecution: TemporalIO[ZWorkflowExecution] =
ZWorkflowStub.start(
stub.someMethod(someArg)
)
Type parameters
- A
-
workflow result type
Value parameters
- f
-
the workflow method invocation
Attributes
- Returns
-
the workflow execution metadata
- Inherited from:
- ZWorkflowExecutionSyntax