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

zio.temporal

package zio.temporal

Members list

Packages

package zio.temporal.activity
package zio.temporal.build
package zio.temporal.failure
package zio.temporal.internal
package zio.temporal.json
package zio.temporal.protobuf

Protobuf-aware conveniences.

Protobuf-aware conveniences.

The important members here are scalapbMessageZTemporalCodec and scalapbSealedOneofZTemporalCodec, which auto-derive a ZTemporalCodec for any ScalaPB-generated scalapb.GeneratedMessage or scalapb.GeneratedSealedOneof. The zio-json JsonEncoder/JsonDecoder carried by those codecs are deliberate stubs that must never actually run — the encoder throws, the decoder fails with a Left(msg) decode error — at runtime, ScalapbPayloadConverter handles protobuf types before zio.temporal.json.ZioJsonPayloadConverter is reached in ProtobufDataConverter's chain, so the stubs are never called.

'''Scope warning — the JsonEncoder/JsonDecoder bridges are deliberately not provided at the package-object level.''' They live in ScalapbJsonImplicits and must be imported explicitly, because making them globally implicit-visible would hijack every zio-json call site the user has for protobuf types — including any unrelated logging/HTTP use — and cause it to throw at runtime.

Use them only where zio-json's own derivation needs to see encoder/decoder evidence for a protobuf type inside a generic structure (e.g. Either[Foo, MyProtobufMsg]).

Attributes

package zio.temporal.query
package zio.temporal.schedules
package zio.temporal.signal
package zio.temporal.state
package zio.temporal.testkit
package zio.temporal.worker
package zio.temporal.workflow

Type members

Classlikes

object TypeIsSpecified extends TypeIsSpecified[Any]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class TypeIsSpecified[Any]
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class TypeIsSpecified[-E]

Attributes

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

Attributes

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

Represents options for zio.temporal.workflow.ZWorkflowServiceStubs.awaitTermination method

Represents options for zio.temporal.workflow.ZWorkflowServiceStubs.awaitTermination method

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final class ZCurrentTimeMillis extends AnyVal

Represents current timestamp in epoch millis format

Represents current timestamp in epoch millis format

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
final class ZHistoryEvent(val toJava: HistoryEvent)

NOTE: the wrapper is incomplete, contains only basic information

NOTE: the wrapper is incomplete, contains only basic information

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class ZRetryOptions

Represents temporal retry options

Represents temporal retry options

Attributes

See also

RetryOptions

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

Attributes

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ZSearchAttribute

Base type for attribute value.

Base type for attribute value.

Restricted to allowed elasticsearch types.

Attributes

See also
Companion
object
Supertypes
class Object
trait Matchable
class Any
object ZSearchAttributeMeta extends ZSearchAttributeMetaCollectionInstances, ZSearchAttributeMetaEnumInstances

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ZSearchAttributeMeta[A, Tag]

Encapsulates description & recipe for a Scala type stored as Temporal Search attribute.

Encapsulates description & recipe for a Scala type stored as Temporal Search attribute.

Type parameters

A

Scala type

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class KeywordListMeta[V]
class KeywordMeta[V]
Self type
trait ZSearchAttributeMetaCollectionInstances

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ZSearchAttributeMetaEnumInstances

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
final class ZSearchAttributes

Immutable collection of typed search attributes.

Immutable collection of typed search attributes.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ZSearchAttributes

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ZWorkflowExecution(val toJava: WorkflowExecution)

Represents workflow execution information

Represents workflow execution information

Attributes

See also

WorkflowExecution

Supertypes
class Object
trait Matchable
class Any
final class ZWorkflowExecutionHistory(val toJava: WorkflowExecutionHistory)

Provides a wrapper with convenience methods over raw protobuf History object representing workflow history

Provides a wrapper with convenience methods over raw protobuf History object representing workflow history

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ZWorkflowExecutionHistory

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ZWorkflowExecutionMetadata(val toJava: WorkflowExecutionMetadata)

Attributes

Supertypes
class Object
trait Matchable
class Any
final class ZWorkflowInfo

Represents current workflow information

Represents current workflow information

Attributes

See also

WorkflowInfo

Supertypes
class Object
trait Matchable
class Any
class experimentalApi extends StaticAnnotation

Indicates that public method is still experimental and may change

Indicates that public method is still experimental and may change

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class internalApi extends StaticAnnotation

Indicates that public method is not recommended for use outside of the zio.tempora itself

Indicates that public method is not recommended for use outside of the zio.tempora itself

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any

Types

final type TemporalIO[+A] = ZIO[Any, TemporalException, A]

Alias for IO representing interaction with temporal server

Alias for IO representing interaction with temporal server

Type parameters

A

the value type

Attributes

final type TemporalRIO[-R, +A] = ZIO[R, TemporalException, A]

Alias for IO representing interaction with temporal server

Alias for IO representing interaction with temporal server

Type parameters

A

the value type

R

environment type

Attributes

final type ZTemporalCodec[A] = ZTemporalCodec[A]

Re-exports so a single import zio.temporal.* brings the codec typeclass and the registry into scope.

Re-exports so a single import zio.temporal.* brings the codec typeclass and the registry into scope.

Attributes

final type activityInterface = ActivityInterface
final type activityMethod = ActivityMethod
final type queryMethod = QueryMethod
final type signalMethod = SignalMethod
final type workflowInterface = WorkflowInterface
final type workflowMethod = WorkflowMethod

Value members

Concrete methods

def nameOf[A : ClassTag]: String

Retrieves class name of a given type. Useful when specifying 'doNotRetry' errors in retry policies.

Retrieves class name of a given type. Useful when specifying 'doNotRetry' errors in retry policies.

Attributes

See also
def simpleNameOf[A : ClassTag]: String

Retrieves simple class name of a given type. Useful when specifying creating untyped stubs.

Retrieves simple class name of a given type. Useful when specifying creating untyped stubs.

Attributes

Concrete fields

Implicits

Implicits

implicit def toTallyDuration(duration: Duration): Duration

Temporal uses tally-core that has it's own com.uber.m3.util.Duration class. This method converts zio.Duration so that consumers won't need to use tally's one.

Temporal uses tally-core that has it's own com.uber.m3.util.Duration class. This method converts zio.Duration so that consumers won't need to use tally's one.

Attributes

Generated with