package workflow
- Alphabetic
- Public
- Protected
Type Members
- trait ExtendsWorkflow[A] extends AnyRef
- trait ExtendsWorkflowImplicits extends AnyRef
- trait HasPublicNullaryConstructor[A] extends AnyRef
- trait HasPublicNullaryConstructorImplicits extends AnyRef
- trait IsConcreteClass[A] extends AnyRef
- trait IsConcreteClassImplicits extends AnyRef
- trait IsWorkflow[A] extends AnyRef
- trait IsWorkflowImplicits extends AnyRef
- sealed trait ZAsync[+A] extends AnyRef
Contains result of an asynchronous computation.
Contains result of an asynchronous computation. Similar to zio.IO with the following differences:
- Can be used only inside a Temporal workflow code. Use zio.ZIO and its derivatives to implement activities
and workflow starting and querying code.
run
method doesn't throw InterruptedException. The only way to unblockrun
is to complete the ZAsync
2. ZAsync doesn't directly supports cancellation. Use io.temporal.workflow.CancellationScope to cancel and handle cancellations. The pattern is that a canceled operation completes its ZAsync with io.temporal.failure.CanceledFailure when canceled.
3. Unlike zio.IO (that is lazy), ZAsync is strict. Whenever a ZAsync is created, The thunk is immediately started
- Can be used only inside a Temporal workflow code. Use zio.ZIO and its derivatives to implement activities
and workflow starting and querying code.
- final class ZCancellationScope extends AnyRef
Handle to a cancellation scope created through ZWorkflow.newCancellationScope or ZWorkflow.newDetachedCancellationScope.
Handle to a cancellation scope created through ZWorkflow.newCancellationScope or ZWorkflow.newDetachedCancellationScope. Supports explicit cancelling of the code a cancellation scope wraps. The code in the CancellationScope has to be executed using run method.
- trait ZChildWorkflowExecutionSyntax extends AnyRef
- final case class ZChildWorkflowOptions extends Product with Serializable
- sealed trait ZChildWorkflowStub extends BasicStubOps
Represents untyped child workflow stub
Represents untyped child workflow stub
- See also
ChildWorkflowStub
- final class ZChildWorkflowStubImpl extends ZChildWorkflowStub
- final case class ZContinueAsNewOptions extends Product with Serializable
This class contain overrides for continueAsNew call.
This class contain overrides for continueAsNew call. Every field can be null and it means that the value of the option should be taken from the originating workflow run.
- sealed trait ZExternalWorkflowStub extends BasicStubOps
Represents untyped external workflow stub
Represents untyped external workflow stub
- See also
ExternalWorkflowStub
- final class ZExternalWorkflowStubImpl extends ZExternalWorkflowStub
- class ZQueueConsumer[E] extends AnyRef
- trait ZQueueProducer[E] extends AnyRef
- sealed trait ZSaga[+A] extends AnyRef
Implements the logic to execute compensation operations that is often required in Saga applications.
Implements the logic to execute compensation operations that is often required in Saga applications. The following is a skeleton to show of how it is supposed to be used in workflow code:
- A
value type
- See also
https://en.wikipedia.org/wiki/Compensating_transaction
- final class ZWorkerBuildIdVersionSets extends AnyRef
Represents the sets of compatible Build Ids associated with a particular task queue.
Represents the sets of compatible Build Ids associated with a particular task queue.
- Note
experimental in Java SDK
- final class ZWorkflowClient extends AnyRef
Represents Temporal workflow client
Represents Temporal workflow client
- See also
WorkflowClient
- final case class ZWorkflowClientOptions extends Product with Serializable
Represents Temporal workflow client options
Represents Temporal workflow client options
- See also
WorkflowClientOptions
- sealed trait ZWorkflowContinueAsNewStub extends BasicStubOps
- class ZWorkflowContinueAsNewStubImpl extends ZWorkflowContinueAsNewStub
- trait ZWorkflowContinueAsNewStubSyntax extends AnyRef
- trait ZWorkflowExecutionSyntax extends AnyRef
- final case class ZWorkflowImplementationClass[T] extends Product with Serializable
Type-safe wrapper of Class.
Type-safe wrapper of Class. The wrapper can be constructed only if the wrapped type T is a correct workflow implementation
- T
workflow implementation type.
- final case class ZWorkflowOptions extends Product with Serializable
Options used to configure how a workflow is executed.
- final class ZWorkflowQueue[E] extends ZQueueConsumer[E] with ZQueueProducer[E]
- final class ZWorkflowServiceStubs extends AnyRef
Initializes and holds gRPC blocking and future stubs.
- final case class ZWorkflowServiceStubsOptions extends Product with Serializable
Represents temporal workflow service stubs options
Represents temporal workflow service stubs options
- See also
WorkflowServiceStubsOptions
- sealed trait ZWorkflowStub extends BasicStubOps with ZWorkflowClientSignalWithStartSyntax
- final class ZWorkflowStubImpl extends ZWorkflowStub
Represents untyped workflow stub
Represents untyped workflow stub
- See also
WorkflowStub
Deprecated Type Members
- class ZChildWorkflowStubBuilder[Res] extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Build ZChildWorkflowOptions and provide it directly
- class ZWorkflowContinueAsNewStubBuilder[A] extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Build ZContinueAsNewOptions and provide it directly
- final class ZWorkflowStubBuilder[Res] extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Build ZWorkflowOptions and provide it directly
- final class ZWorkflowStubBuilderTaskQueueDsl[Res] extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Build ZWorkflowOptions and provide it directly
- final class ZWorkflowStubBuilderWorkflowIdDsl[Res] extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Build ZWorkflowOptions and provide it directly
Value Members
- object ExtendsWorkflow extends ExtendsWorkflowImplicits
- object HasPublicNullaryConstructor extends HasPublicNullaryConstructorImplicits
- object IsConcreteClass extends IsConcreteClassImplicits
- object IsWorkflow extends IsWorkflowImplicits
- object ZAsync
- object ZCancellationScope
- object ZChildWorkflowOptions extends Serializable
- object ZChildWorkflowStub extends Stubs[ZChildWorkflowStub] with ZChildWorkflowExecutionSyntax with ZChildWorkflowStubSignalSyntax
- object ZContinueAsNewOptions extends Serializable
- object ZExternalWorkflowStub extends Stubs[ZExternalWorkflowStub] with ZExternalWorkflowStubSignalSyntax
- object ZSaga
- object ZWorkerBuildIdVersionSets
- object ZWorkflow extends ZWorkflowVersionSpecific
- object ZWorkflowClient
- object ZWorkflowClientOptions extends ConfigurationCompanion[ZWorkflowClientOptions] with Serializable
- object ZWorkflowContinueAsNewStub extends Stubs[ZWorkflowContinueAsNewStub] with ZWorkflowContinueAsNewStubSyntax
- object ZWorkflowImplementationClass extends Serializable
- object ZWorkflowOptions extends Serializable
- object ZWorkflowServiceStubs
- object ZWorkflowServiceStubsOptions extends ConfigurationCompanion[ZWorkflowServiceStubsOptions] with Serializable
- object ZWorkflowStub extends Stubs[ZWorkflowStub] with ZWorkflowExecutionSyntax with ZWorkflowStubSignalSyntax with ZWorkflowStubQuerySyntax
Deprecated Value Members
- object ZChildWorkflowStubBuilder
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Build ZChildWorkflowOptions and provide it directly
- object ZWorkflowStubBuilderTaskQueueDsl
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Build ZWorkflowOptions and provide it directly