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

zio.temporal.workflow

package zio.temporal.workflow

Members list

Type members

Classlikes

object ExtendsWorkflow extends ExtendsWorkflowImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ExtendsWorkflow[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ExtendsWorkflowImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ExtendsWorkflowImplicits

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait HasPublicNullaryConstructor[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object HasPublicNullaryConstructor extends HasPublicNullaryConstructorImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait HasPublicNullaryConstructorImplicits

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object HasPublicNullaryConstructorImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object IsConcreteClass extends IsConcreteClassImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait IsConcreteClass[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait IsConcreteClassImplicits

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IsConcreteClassImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object IsWorkflow extends IsWorkflowImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
IsWorkflow.type
trait IsWorkflow[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait IsWorkflowImplicits

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IsWorkflow
object IsWorkflowImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ZAsync[+A]

Contains result of an asynchronous computation. Similar to zio.IO with the following differences:

Contains result of an asynchronous computation. Similar to zio.IO with the following differences:

  1. 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 unblock run 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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
ZAsync[A]
object ZAsync

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
ZAsync.type
final class ZCancellationScope

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.

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.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ZCancellationScope

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait ZChildWorkflowExecutionSyntax

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ZChildWorkflowExecutionSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object ZChildWorkflowOptions

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZChildWorkflowOptions

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZChildWorkflowStub extends ZChildWorkflowExecutionSyntax, ZChildWorkflowStubSignalSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ZChildWorkflowStub extends BasicStubOps

Represents untyped child workflow stub

Represents untyped child workflow stub

Attributes

See also

ChildWorkflowStub

Companion
object
Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
Known subtypes
final class ZChildWorkflowStubImpl(val toJava: ChildWorkflowStub, val stubbedClass: Class[_]) extends ZChildWorkflowStub

Attributes

Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
object ZContinueAsNewOptions

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZContinueAsNewOptions

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.

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZExternalWorkflowStub extends ZExternalWorkflowStubSignalSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ZExternalWorkflowStub extends BasicStubOps

Represents untyped external workflow stub

Represents untyped external workflow stub

Attributes

See also

ExternalWorkflowStub

Companion
object
Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
Known subtypes
final class ZExternalWorkflowStubImpl(val toJava: ExternalWorkflowStub, val stubbedClass: Class[_]) extends ZExternalWorkflowStub

Attributes

Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
class ZQueueConsumer[E]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ZWorkflowQueue[E]
trait ZQueueProducer[E]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ZWorkflowQueue[E]
sealed trait ZSaga[+A]

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:

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:

Type parameters

A

value type

Attributes

See also
Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
ZSaga[A]
object ZSaga

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ZSaga.type
final class ZWorkerBuildIdVersionSets

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.

Attributes

Note

experimental in Java SDK

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ZWorkerBuildIdVersionSets

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object ZWorkflow extends ZWorkflowVersionSpecific

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
ZWorkflow.type
object ZWorkflowClient

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ZWorkflowClient

Represents Temporal workflow client

Represents Temporal workflow client

The codecRegistry carried here is the ''same'' CodecRegistry instance that backs this client's DataConverter (when the default zio-json data converter is in use). Auto-registration call sites (newWorkflowStub[A], ZWorker.addWorkflow[I], …) mutate it at invocation time so users no longer need to chain .addInterface[...] by hand. None indicates the user supplied a custom DataConverter via withDataConverter(raw); in that case auto-registration is a silent no-op.

Attributes

See also

WorkflowClient

Companion
object
Supertypes
class Object
trait Matchable
class Any
final case class ZWorkflowClientOptions

Represents Temporal workflow client options

Represents Temporal workflow client options

Attributes

See also

WorkflowClientOptions

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZWorkflowClientOptions extends ConfigurationCompanion[ZWorkflowClientOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
sealed trait ZWorkflowContinueAsNewStub extends BasicStubOps

Attributes

Companion
object
Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
Known subtypes
object ZWorkflowContinueAsNewStub extends ZWorkflowContinueAsNewStubSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class ZWorkflowContinueAsNewStubImpl(val workflowType: String, val options: ContinueAsNewOptions, val stubbedClass: Class[_]) extends ZWorkflowContinueAsNewStub

Attributes

Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
trait ZWorkflowContinueAsNewStubSyntax

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ZWorkflowContinueAsNewStubSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object ZWorkflowExecutionSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ZWorkflowExecutionSyntax

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ZWorkflowStub
final case class ZWorkflowImplementationClass[T]

Type-safe wrapper of Class. The wrapper can be constructed only if the wrapped type T is a correct workflow implementation

Type-safe wrapper of Class. The wrapper can be constructed only if the wrapped type T is a correct workflow implementation

Type parameters

T

workflow implementation type.

Value parameters

runtimeClass

the runtime class of the workflow

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZWorkflowImplementationClass

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ZWorkflowOptions

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZWorkflowOptions

Options used to configure how a workflow is executed.

Options used to configure how a workflow is executed.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final class ZWorkflowQueue[E] extends ZQueueConsumer[E], ZQueueProducer[E]

Attributes

Supertypes
trait ZQueueProducer[E]
class ZQueueConsumer[E]
class Object
trait Matchable
class Any
final class ZWorkflowServiceStubs

Initializes and holds gRPC blocking and future stubs.

Initializes and holds gRPC blocking and future stubs.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ZWorkflowServiceStubs

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object ZWorkflowServiceStubsOptions extends ConfigurationCompanion[ZWorkflowServiceStubsOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
final case class ZWorkflowServiceStubsOptions

Represents temporal workflow service stubs options

Represents temporal workflow service stubs options

Attributes

See also

WorkflowServiceStubsOptions

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait ZWorkflowStub extends BasicStubOps, ZWorkflowClientSignalWithStartSyntax

Attributes

Companion
object
Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
Known subtypes
object ZWorkflowStub extends ZWorkflowExecutionSyntax, ZWorkflowStubSignalSyntax, ZWorkflowStubQuerySyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Show all
Self type
final class ZWorkflowStubImpl(val toJava: WorkflowStub, val stubbedClass: Class[_]) extends ZWorkflowStub

Represents untyped workflow stub

Represents untyped workflow stub

Attributes

See also

WorkflowStub

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

Deprecated classlikes

object ZChildWorkflowStubBuilder

Attributes

Companion
class
Deprecated
[Since version 0.6.0] Build ZChildWorkflowOptions and provide it directly
Supertypes
class Object
trait Matchable
class Any
Self type
class ZChildWorkflowStubBuilder[Res]

Attributes

Companion
object
Deprecated
[Since version 0.6.0] Build ZChildWorkflowOptions and provide it directly
Supertypes
class Object
trait Matchable
class Any
class ZWorkflowContinueAsNewStubBuilder[A](configure: Builder => Builder)(implicit evidence$1: ClassTag[A], evidence$2: IsWorkflow[A])

Attributes

Deprecated
[Since version 0.6.0] Build ZContinueAsNewOptions and provide it directly
Supertypes
class Object
trait Matchable
class Any
final class ZWorkflowStubBuilder[Res]

Attributes

Deprecated
[Since version 0.6.0] Build ZWorkflowOptions and provide it directly
Supertypes
class Object
trait Matchable
class Any
final class ZWorkflowStubBuilderTaskQueueDsl[Res]

Attributes

Companion
object
Deprecated
[Since version 0.6.0] Build ZWorkflowOptions and provide it directly
Supertypes
class Object
trait Matchable
class Any
object ZWorkflowStubBuilderTaskQueueDsl

Attributes

Companion
class
Deprecated
[Since version 0.6.0] Build ZWorkflowOptions and provide it directly
Supertypes
class Object
trait Matchable
class Any
Self type
final class ZWorkflowStubBuilderWorkflowIdDsl[Res]

Attributes

Deprecated
[Since version 0.6.0] Build ZWorkflowOptions and provide it directly
Supertypes
class Object
trait Matchable
class Any
Generated with