Class WorkflowExecution

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Representation of a workflow execution.

public class WorkflowExecution

Inheritance

object

WorkflowExecution

Derived

WorkflowExecutionDescription

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WorkflowExecution(WorkflowExecutionInfo, DataConverter)

Initializes a new instance of the WorkflowExecution class.

protected WorkflowExecution(WorkflowExecutionInfo rawInfo, DataConverter dataConverter)

Parameters

rawInfo WorkflowExecutionInfo

Raw proto info.

dataConverter DataConverter

Data converter used for memos.

Remarks

WARNING: This constructor may be mutated in backwards incompatible ways.

Properties

CloseTime

Gets when the workflow was closed if closed.

public DateTime? CloseTime { get; }

Property Value

DateTime?

ExecutionTime

Gets when the workflow run started or should start.

public DateTime? ExecutionTime { get; }

Property Value

DateTime?

HistoryLength

Gets the number of events in history.

public int HistoryLength { get; }

Property Value

int

Id

Gets the ID for the workflow.

public string Id { get; }

Property Value

string

Memo

Gets the workflow memo dictionary, lazily creating when accessed.

public IReadOnlyDictionary<string, IEncodedRawValue> Memo { get; }

Property Value

IReadOnlyDictionary<string, IEncodedRawValue>

ParentId

Gets the ID for the parent workflow if this was started as a child.

public string? ParentId { get; }

Property Value

string

ParentRunId

Gets the run ID for the parent workflow if this was started as a child.

public string? ParentRunId { get; }

Property Value

string

RunId

Gets the run ID for the workflow.

public string RunId { get; }

Property Value

string

StartTime

Gets when the workflow was created.

public DateTime StartTime { get; }

Property Value

DateTime

Status

Gets the status for the workflow.

public WorkflowExecutionStatus Status { get; }

Property Value

WorkflowExecutionStatus

TaskQueue

Gets the task queue for the workflow.

public string TaskQueue { get; }

Property Value

string

TypedSearchAttributes

Gets the search attributes on the workflow.

public SearchAttributeCollection TypedSearchAttributes { get; }

Property Value

SearchAttributeCollection

Remarks

This is lazily converted on first access.

WorkflowType

Gets the type name of the workflow.

public string WorkflowType { get; }

Property Value

string