output
    Preparing search index...

    Interface WorkflowDetails

    interface WorkflowDetails {
        attempt: number;
        continuedFromExecutionRunId?: string;
        firstExecutionRunId: string;
        parent?: { namespace: string; runId: string; workflowId: string };
        root?: { runId: string; workflowId: string };
        runId: string;
        runStartTime: number;
        startTime: number;
        workflowId: string;
        workflowType: string;
    }
    Index

    Properties

    attempt continuedFromExecutionRunId? firstExecutionRunId parent? root? runId runStartTime startTime workflowId workflowType

    Properties

    attempt: number

    Starts at 1 and increments for every retry if there is a retryPolicy

    continuedFromExecutionRunId?: string

    The last Run Id in this Execution Chain

    firstExecutionRunId: string

    Run Id of the first Run in this Execution Chain

    parent?: { namespace: string; runId: string; workflowId: string }

    Parent Workflow info (present if this is a Child Workflow)

    Type Declaration

    • namespace: string

      Namespace this Workflow is executing in

    • runId: string

      ID of a single Workflow run

    • workflowId: string

      ID of the Workflow, this can be set by the client during Workflow creation. A single Workflow may run multiple times e.g. when scheduled with cron.

    root?: { runId: string; workflowId: string }

    The root workflow execution, defined as follows:

    1. A workflow without a parent workflow is its own root workflow.
    2. A workflow with a parent workflow has the same root workflow as its parent.

    When there is no parent workflow, i.e., the workflow is its own root workflow, this field is undefined.

    Note that Continue-as-New (or reset) propagates the workflow parentage relationship, and therefore, whether the new workflow has the same root workflow as the original one depends on whether it had a parent.

    Type Declaration

    • runId: string

      ID of a single Workflow run

    • workflowId: string

      ID of the Workflow, this can be set by the client during Workflow creation. A single Workflow may run multiple times e.g. when scheduled with cron.

    runId: string

    ID of a single Workflow run

    runStartTime: number

    Time at which the current Workflow Run started

    startTime: number

    Time at which this Workflow Execution Chain was started

    workflowId: string

    ID of the Workflow, this can be set by the client during Workflow creation. A single Workflow may run multiple times e.g. when scheduled with cron.

    workflowType: string

    Workflow function's name

    Settings

    Member Visibility

    On This Page

    Properties