Class WorkflowExecutionInfo

Namespace

Temporalio.Api.Workflow.V1

Assembly

Temporalio.dll

Hold basic information about a workflow execution. This structure is a part of visibility, and thus contain a limited subset of information.

public sealed class WorkflowExecutionInfo : IMessage<WorkflowExecutionInfo>, IEquatable<WorkflowExecutionInfo>, IDeepCloneable<WorkflowExecutionInfo>, IBufferMessage, IMessage

Inheritance

object

WorkflowExecutionInfo

Implements

IMessage<WorkflowExecutionInfo>

IEquatable<WorkflowExecutionInfo>

IDeepCloneable<WorkflowExecutionInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowExecutionInfo()

public WorkflowExecutionInfo()

WorkflowExecutionInfo(WorkflowExecutionInfo)

public WorkflowExecutionInfo(WorkflowExecutionInfo other)

Parameters

other WorkflowExecutionInfo

Fields

AssignedBuildIdFieldNumber

Field number for the "assigned_build_id" field.

public const int AssignedBuildIdFieldNumber = 19

Field Value

int

AutoResetPointsFieldNumber

Field number for the "auto_reset_points" field.

public const int AutoResetPointsFieldNumber = 12

Field Value

int

CloseTimeFieldNumber

Field number for the "close_time" field.

public const int CloseTimeFieldNumber = 4

Field Value

int

ExecutionDurationFieldNumber

Field number for the "execution_duration" field.

public const int ExecutionDurationFieldNumber = 17

Field Value

int

ExecutionFieldNumber

Field number for the "execution" field.

public const int ExecutionFieldNumber = 1

Field Value

int

ExecutionTimeFieldNumber

Field number for the "execution_time" field.

public const int ExecutionTimeFieldNumber = 9

Field Value

int

FirstRunIdFieldNumber

Field number for the "first_run_id" field.

public const int FirstRunIdFieldNumber = 21

Field Value

int

HistoryLengthFieldNumber

Field number for the "history_length" field.

public const int HistoryLengthFieldNumber = 6

Field Value

int

HistorySizeBytesFieldNumber

Field number for the "history_size_bytes" field.

public const int HistorySizeBytesFieldNumber = 15

Field Value

int

InheritedBuildIdFieldNumber

Field number for the "inherited_build_id" field.

public const int InheritedBuildIdFieldNumber = 20

Field Value

int

MemoFieldNumber

Field number for the "memo" field.

public const int MemoFieldNumber = 10

Field Value

int

MostRecentWorkerVersionStampFieldNumber

Field number for the "most_recent_worker_version_stamp" field.

public const int MostRecentWorkerVersionStampFieldNumber = 16

Field Value

int

ParentExecutionFieldNumber

Field number for the "parent_execution" field.

public const int ParentExecutionFieldNumber = 8

Field Value

int

ParentNamespaceIdFieldNumber

Field number for the "parent_namespace_id" field.

public const int ParentNamespaceIdFieldNumber = 7

Field Value

int

PriorityFieldNumber

Field number for the "priority" field.

public const int PriorityFieldNumber = 24

Field Value

int

RootExecutionFieldNumber

Field number for the "root_execution" field.

public const int RootExecutionFieldNumber = 18

Field Value

int

SearchAttributesFieldNumber

Field number for the "search_attributes" field.

public const int SearchAttributesFieldNumber = 11

Field Value

int

StartTimeFieldNumber

Field number for the "start_time" field.

public const int StartTimeFieldNumber = 3

Field Value

int

StateTransitionCountFieldNumber

Field number for the "state_transition_count" field.

public const int StateTransitionCountFieldNumber = 14

Field Value

int

StatusFieldNumber

Field number for the "status" field.

public const int StatusFieldNumber = 5

Field Value

int

TaskQueueFieldNumber

Field number for the "task_queue" field.

public const int TaskQueueFieldNumber = 13

Field Value

int

TypeFieldNumber

Field number for the "type" field.

public const int TypeFieldNumber = 2

Field Value

int

VersioningInfoFieldNumber

Field number for the "versioning_info" field.

public const int VersioningInfoFieldNumber = 22

Field Value

int

WorkerDeploymentNameFieldNumber

Field number for the "worker_deployment_name" field.

public const int WorkerDeploymentNameFieldNumber = 23

Field Value

int

Properties

AssignedBuildId

The currently assigned build ID for this execution. Presence of this value means worker versioning is used for this execution. Assigned build ID is selected based on Worker Versioning Assignment Rules when the first workflow task of the execution is scheduled. If the first workflow task fails and is scheduled again, the assigned build ID may change according to the latest versioning rules. Assigned build ID can also change in the middle of a execution if Compatible Redirect Rules are applied to this execution. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

[Obsolete]
public string AssignedBuildId { get; set; }

Property Value

string

AutoResetPoints

public ResetPoints AutoResetPoints { get; set; }

Property Value

ResetPoints

CloseTime

public Timestamp CloseTime { get; set; }

Property Value

Timestamp

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Execution

public WorkflowExecution Execution { get; set; }

Property Value

WorkflowExecution

ExecutionDuration

Workflow execution duration is defined as difference between close time and execution time. This field is only populated if the workflow is closed.

public Duration ExecutionDuration { get; set; }

Property Value

Duration

ExecutionTime

public Timestamp ExecutionTime { get; set; }

Property Value

Timestamp

FirstRunId

The first run ID in the execution chain. Executions created via the following operations are considered to be in the same chain

• ContinueAsNew
• Workflow Retry
• Workflow Reset
• Cron Schedule

public string FirstRunId { get; set; }

Property Value

string

HistoryLength

public long HistoryLength { get; set; }

Property Value

long

HistorySizeBytes

public long HistorySizeBytes { get; set; }

Property Value

long

InheritedBuildId

Build ID inherited from a previous/parent execution. If present, assigned_build_id will be set to this, instead of using the assignment rules. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

[Obsolete]
public string InheritedBuildId { get; set; }

Property Value

string

Memo

public Memo Memo { get; set; }

Property Value

Memo

MostRecentWorkerVersionStamp

If set, the most recent worker version stamp that appeared in a workflow task completion Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

[Obsolete]
public WorkerVersionStamp MostRecentWorkerVersionStamp { get; set; }

Property Value

WorkerVersionStamp

ParentExecution

public WorkflowExecution ParentExecution { get; set; }

Property Value

WorkflowExecution

ParentNamespaceId

public string ParentNamespaceId { get; set; }

Property Value

string

Parser

public static MessageParser<WorkflowExecutionInfo> Parser { get; }

Property Value

MessageParser<WorkflowExecutionInfo>

Priority

Priority metadata

public Priority Priority { get; set; }

Property Value

Priority

RootExecution

Contains information about the root workflow execution. 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.

public WorkflowExecution RootExecution { get; set; }

Property Value

WorkflowExecution

SearchAttributes

public SearchAttributes SearchAttributes { get; set; }

Property Value

SearchAttributes

StartTime

public Timestamp StartTime { get; set; }

Property Value

Timestamp

StateTransitionCount

public long StateTransitionCount { get; set; }

Property Value

long

Status

public WorkflowExecutionStatus Status { get; set; }

Property Value

WorkflowExecutionStatus

TaskQueue

public string TaskQueue { get; set; }

Property Value

string

Type

public WorkflowType Type { get; set; }

Property Value

WorkflowType

VersioningInfo

Absent value means the workflow execution is not versioned. When present, the execution might be versioned or unversioned, depending on versioning_info.behavior and versioning_info.versioning_override. Experimental. Versioning info is experimental and might change in the future.

public WorkflowExecutionVersioningInfo VersioningInfo { get; set; }

Property Value

WorkflowExecutionVersioningInfo

WorkerDeploymentName

The name of Worker Deployment that completed the most recent workflow task. Experimental. Worker Deployments are experimental and might change in the future.

public string WorkerDeploymentName { get; set; }

Property Value

string

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public WorkflowExecutionInfo Clone()

Returns

WorkflowExecutionInfo

A deep clone of this object.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(WorkflowExecutionInfo)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(WorkflowExecutionInfo other)

Parameters

other WorkflowExecutionInfo

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(WorkflowExecutionInfo)

Merges the given message into this one.

public void MergeFrom(WorkflowExecutionInfo other)

Parameters

other WorkflowExecutionInfo

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.