Documentation

WorkflowExecutionInfo
in package

FinalYes

DTO that contains basic information about Workflow Execution.

Tags
see
WorkflowExecutionInfo
psalm-immutable

Table of Contents

Properties

$autoResetPoints  : array<string|int, ResetPointInfo>
$closeTime  : DateTimeInterface|null
$execution  : WorkflowExecution
$executionDuration  : DateInterval|null
Workflow execution duration is defined as difference between close time and execution time.
$executionTime  : DateTimeInterface|null
$firstRunId  : string
The first run ID in the execution chain.
$historyLength  : int
$historySizeBytes  : int<1, max>
$memo  : EncodedCollection
$mostRecentWorkerVersionStamp  : WorkerVersionStamp|null
If set, the most recent worker version stamp that appeared in a workflow task completion
$parentExecution  : WorkflowExecution|null
$parentNamespaceId  : string|null
$rootExecution  : WorkflowExecution|null
Contains information about the root workflow execution.
$searchAttributes  : EncodedCollection
$startTime  : DateTimeInterface|null
$stateTransitionCount  : int<1, max>
$status  : WorkflowExecutionStatus
$taskQueue  : non-empty-string
$type  : WorkflowType

Methods

__construct()  : mixed

Attributes

#[Immutable]

#[Immutable]

Properties

$executionDuration read-only

Workflow execution duration is defined as difference between close time and execution time.

public DateInterval|null $executionDuration

This field is only populated if the workflow is closed.

$firstRunId read-only

The first run ID in the execution chain.

public string $firstRunId

Executions created via the following operations are considered to be in the same chain

  • ContinueAsNew
  • Workflow Retry
  • Workflow Reset
  • Cron Schedule

$mostRecentWorkerVersionStamp read-only

If set, the most recent worker version stamp that appeared in a workflow task completion

public WorkerVersionStamp|null $mostRecentWorkerVersionStamp
Tags
deprecated

$rootExecution read-only

Contains information about the root workflow execution.

public WorkflowExecution|null $rootExecution

The root workflow execution is defined as follows:

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

Note: workflows continued as new or reseted may or may not have parents, check examples below.

Examples: Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3. - The root workflow of all three workflows is W1. Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3. - The root workflow of all three workflows is W1. Scenario 3: Workflow W1 continued as new W2. - The root workflow of W1 is W1 and the root workflow of W2 is W2. Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3 - The root workflow of all three workflows is W1. Scenario 5: Workflow W1 is reseted, creating W2. - The root workflow of W1 is W1 and the root workflow of W2 is W2.

Methods

__construct()

public __construct(WorkflowExecution $execution, WorkflowType $type, DateTimeInterface|null $startTime, DateTimeInterface|null $closeTime, WorkflowExecutionStatus $status, int $historyLength, string|null $parentNamespaceId, WorkflowExecution|null $parentExecution, DateTimeInterface|null $executionTime, EncodedCollection $memo, EncodedCollection $searchAttributes, array<string|int, mixed> $autoResetPoints, string $taskQueue, int $stateTransitionCount, int $historySizeBytes, WorkerVersionStamp|null $mostRecentWorkerVersionStamp, DateInterval|null $executionDuration, WorkflowExecution|null $rootExecution, string $firstRunId) : mixed
Parameters
$execution : WorkflowExecution
$type : WorkflowType
$startTime : DateTimeInterface|null
$closeTime : DateTimeInterface|null
$status : WorkflowExecutionStatus
$historyLength : int
$parentNamespaceId : string|null
$parentExecution : WorkflowExecution|null
$executionTime : DateTimeInterface|null
$memo : EncodedCollection
$searchAttributes : EncodedCollection
$autoResetPoints : array<string|int, mixed>
$taskQueue : string
$stateTransitionCount : int
$historySizeBytes : int
$mostRecentWorkerVersionStamp : WorkerVersionStamp|null
$executionDuration : DateInterval|null
$rootExecution : WorkflowExecution|null
$firstRunId : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results