c

zio.temporal.activity

ZActivityExecutionContext

final class ZActivityExecutionContext extends AnyVal

Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZActivityExecutionContext
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  6. def getHeartbeatDetails[V](implicit arg0: TypeIsSpecified[V], arg1: JavaTypeTag[V]): UIO[Option[V]]

    Extracts Heartbeat details from the last failed attempt.

    Extracts Heartbeat details from the last failed attempt. This is used in combination with retry options. An Activity Execution could be scheduled with optional zio.temporal.common.ZRetryOptions via zio.temporal.activity.ZActivityRunOptions. If an Activity Execution failed then the server would attempt to dispatch another Activity Task to retry the execution according to the retry options. If there were Heartbeat details reported by the last Activity Execution that failed, they would be delivered along with the Activity Task for the next retry attempt and can be extracted by the Activity implementation.

    V

    type of the Heartbeat details

  7. def heartbeat[V](details: V): IO[ActivityCompletionException, Unit]

    Used to notify the Workflow Execution that the Activity Execution is alive.

    Used to notify the Workflow Execution that the Activity Execution is alive.

    details

    In case the Activity Execution times out details are returned as a field of the exception that is thrown. The details are also accessible through getHeartbeatDetails on the next Activity Execution retry.

    Exceptions thrown

    ActivityCompletionException Which indicates that cancellation of the Activity Execution was requested by the Workflow Execution. Or it could indicate any other reason for an Activity Execution to stop. Should be rethrown from the Activity implementation to indicate a successful cancellation.

    Note

    use ZIO.orDie if you don't need to handle the exception. Do not ZIO.ignore it! In case you need to do a cleanup on cancellation, use ZIO.onError

  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. val toJava: ActivityExecutionContext
  10. def toString(): String
    Definition Classes
    Any

Inherited from AnyVal

Inherited from Any

Ungrouped