ZWorkflowInfo

zio.temporal.ZWorkflowInfo
final class ZWorkflowInfo

Represents current workflow information

Attributes

See also

WorkflowInfo

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def attempt: Int

Attributes

Returns

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

def continuedExecutionRunId: Option[String]

Attributes

Returns

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

def cronSchedule: Option[String]

Attributes

Returns

Workflow cron schedule

def firstExecutionRunId: String

Attributes

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.

def getHistoryLength: Long

Attributes

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.

def namespace: String

Attributes

Returns

Workflow Namespace

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

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

Attributes

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.

def parentRunId: Option[String]

Attributes

Returns

Run ID of the parent Workflow

def parentWorkflowId: Option[String]

Attributes

Returns

Workflow ID of the parent Workflow

def runId: String

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

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

Attributes

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.

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

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

Attributes

def taskQueue: String

Attributes

Returns

Workflow Task Queue name

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def workflowExecutionTimeout: Duration

Attributes

Returns

Timeout for the Workflow Execution specified during Workflow start

def workflowId: String

Attributes

Returns

Workflow ID

def workflowRunTimeout: Duration

Attributes

Returns

Timeout for a Workflow Run specified during Workflow start

def workflowType: String

Attributes

Returns

Workflow Type

Concrete fields

val toJava: WorkflowInfo