Class WorkflowInfo

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Information about the running workflow. This is immutable for the life of the workflow run.

public record WorkflowInfo : IEquatable<WorkflowInfo>

Inheritance

object

WorkflowInfo

Implements

IEquatable<WorkflowInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: This constructor may have required properties added. Do not rely on the exact constructor, only use "with" clauses.

Constructors

WorkflowInfo(int, string?, string?, TimeSpan?, string, IReadOnlyDictionary<string, Payload>?, Exception?, IReadOnlyCollection<IRawValue>?, string, ParentInfo?, Priority, RetryPolicy?, RootInfo?, string, TimeSpan?, DateTime, string, TimeSpan, string, DateTime, string)

Information about the running workflow. This is immutable for the life of the workflow run.

public WorkflowInfo(int Attempt, string? ContinuedRunId, string? CronSchedule, TimeSpan? ExecutionTimeout, string FirstExecutionRunId, IReadOnlyDictionary<string, Payload>? Headers, Exception? LastFailure, IReadOnlyCollection<IRawValue>? LastResult, string Namespace, WorkflowInfo.ParentInfo? Parent, Priority Priority, RetryPolicy? RetryPolicy, WorkflowInfo.RootInfo? Root, string RunId, TimeSpan? RunTimeout, DateTime StartTime, string TaskQueue, TimeSpan TaskTimeout, string WorkflowId, DateTime WorkflowStartTime, string WorkflowType)

Parameters

Attempt int

Current workflow attempt.

ContinuedRunId string

Run ID if this was continued.

CronSchedule string

Cron schedule if applicable.

ExecutionTimeout TimeSpan?

Execution timeout for the workflow.

FirstExecutionRunId string

The very first run ID the workflow ever had, following continuation chains.

Headers IReadOnlyDictionary<string, Payload>

Headers from when the workflow was started.

LastFailure Exception

Failure if this workflow run is a continuation of a failure.

LastResult IReadOnlyCollection<IRawValue>

Successful result if this workflow is a continuation of a success.

Namespace string

Namespace for the workflow.

Parent WorkflowInfo.ParentInfo

Parent information for the workflow if this is a child.

Priority Priority

The Priority of this workflow.

RetryPolicy RetryPolicy

Retry policy for the workflow.

Root WorkflowInfo.RootInfo

Root information for the workflow. This is nil in pre-1.27.0 server versions or if there is no root (i.e. the root is itself).

RunId string

Run ID for the workflow.

RunTimeout TimeSpan?

Run timeout for the workflow.

StartTime DateTime

Time when the first workflow task started.

TaskQueue string

Task queue for the workflow.

TaskTimeout TimeSpan

Task timeout for the workflow.

WorkflowId string

ID for the workflow.

WorkflowStartTime DateTime

Time when the workflow started on the server.

WorkflowType string

Workflow type name.

Remarks

WARNING: This constructor may have required properties added. Do not rely on the exact constructor, only use "with" clauses.

Properties

Attempt

Current workflow attempt.

public int Attempt { get; init; }

Property Value

int

ContinuedRunId

Run ID if this was continued.

public string? ContinuedRunId { get; init; }

Property Value

string

CronSchedule

Cron schedule if applicable.

public string? CronSchedule { get; init; }

Property Value

string

ExecutionTimeout

Execution timeout for the workflow.

public TimeSpan? ExecutionTimeout { get; init; }

Property Value

TimeSpan?

FirstExecutionRunId

The very first run ID the workflow ever had, following continuation chains.

public string FirstExecutionRunId { get; init; }

Property Value

string

Headers

Headers from when the workflow was started.

public IReadOnlyDictionary<string, Payload>? Headers { get; init; }

Property Value

IReadOnlyDictionary<string, Payload>

LastFailure

Failure if this workflow run is a continuation of a failure.

public Exception? LastFailure { get; init; }

Property Value

Exception

LastResult

Successful result if this workflow is a continuation of a success.

public IReadOnlyCollection<IRawValue>? LastResult { get; init; }

Property Value

IReadOnlyCollection<IRawValue>

Namespace

Namespace for the workflow.

public string Namespace { get; init; }

Property Value

string

Parent

Parent information for the workflow if this is a child.

public WorkflowInfo.ParentInfo? Parent { get; init; }

Property Value

WorkflowInfo.ParentInfo

Priority

The Priority of this workflow.

public Priority Priority { get; init; }

Property Value

Priority

RetryPolicy

Retry policy for the workflow.

public RetryPolicy? RetryPolicy { get; init; }

Property Value

RetryPolicy

Root

Root information for the workflow. This is nil in pre-1.27.0 server versions or if there is no root (i.e. the root is itself).

public WorkflowInfo.RootInfo? Root { get; init; }

Property Value

WorkflowInfo.RootInfo

RunId

Run ID for the workflow.

public string RunId { get; init; }

Property Value

string

RunTimeout

Run timeout for the workflow.

public TimeSpan? RunTimeout { get; init; }

Property Value

TimeSpan?

StartTime

Time when the first workflow task started.

public DateTime StartTime { get; init; }

Property Value

DateTime

TaskQueue

Task queue for the workflow.

public string TaskQueue { get; init; }

Property Value

string

TaskTimeout

Task timeout for the workflow.

public TimeSpan TaskTimeout { get; init; }

Property Value

TimeSpan

WorkflowId

ID for the workflow.

public string WorkflowId { get; init; }

Property Value

string

WorkflowStartTime

Time when the workflow started on the server.

public DateTime WorkflowStartTime { get; init; }

Property Value

DateTime

WorkflowType

Workflow type name.

public string WorkflowType { get; init; }

Property Value

string