Packages

c

zio.temporal

ZWorkflowInfo

final class ZWorkflowInfo extends AnyRef

Represents current workflow information

See also

WorkflowInfo

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def attempt: Int

    returns

    Workflow retry attempt handled by this Workflow code execution. Starts on "1".

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def continuedExecutionRunId: Option[String]

    returns

    Run ID of the previous Workflow Run which continued-as-new or retried or cron-scheduled into the current Workflow Run.

  8. def cronSchedule: Option[String]

    returns

    Workflow cron schedule

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def firstExecutionRunId: String

    returns

    The very first original RunId of the current Workflow Execution preserved along the chain of ContinueAsNew, Retry, Cron and Reset. Identifies the whole Runs chain of Workflow Execution.

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def getHistoryLength: Long

    returns

    length of Workflow history up until the current moment of execution. This value changes during the lifetime of a Workflow Execution. You may use this information to decide when to use continueAsNew.

  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def namespace: String

    returns

    Workflow Namespace

  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. def originalExecutionRunId: String

    Note: This value is NOT preserved by continue-as-new, retries or cron Runs.

    Note: This value is NOT preserved by continue-as-new, retries or cron Runs. They are separate Runs of one Workflow Execution Chain.

    returns

    original RunId of the current Workflow Run. This value is preserved during Reset which changes RunID.

    See also

    firstExecutionRunId for the very first RunId that is preserved along the whole Workflow Execution chain, including ContinueAsNew, Retry, Cron and Reset.

  21. def parentRunId: Option[String]

    returns

    Run ID of the parent Workflow

  22. def parentWorkflowId: Option[String]

    returns

    Workflow ID of the parent Workflow

  23. def runId: String

    Note: RunId is unique identifier of one workflow code execution.

    Note: RunId is unique identifier of one workflow code execution. Reset changes RunId.

    returns

    Workflow Run ID that is handled by the current workflow code execution.

    See also

    originalExecutionRunId for RunId variation that is resistant to Resets

    firstExecutionRunId for the very first RunId that is preserved along the whole Workflow Execution chain, including ContinueAsNew, Retry, Cron and Reset.

  24. def runStartedTimestampMillis: Long

    The time workflow run has started.

    The time workflow run has started. Note that this time can be different from the time workflow function started actual execution.

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def taskQueue: String

    returns

    Workflow Task Queue name

  27. val toJava: WorkflowInfo
  28. def toString(): String
    Definition Classes
    ZWorkflowInfo → AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. def workflowExecutionTimeout: zio.Duration

    returns

    Timeout for the Workflow Execution specified during Workflow start

  33. def workflowId: String

    returns

    Workflow ID

  34. def workflowRunTimeout: zio.Duration

    returns

    Timeout for a Workflow Run specified during Workflow start

  35. def workflowType: String

    returns

    Workflow Type

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped