Table of Contents

Class WorkflowExecutionStartedEventAttributes

Namespace
Temporalio.Api.History.V1
Assembly
Temporalio.dll

Always the first event in workflow history

public sealed class WorkflowExecutionStartedEventAttributes : IMessage<WorkflowExecutionStartedEventAttributes>, IEquatable<WorkflowExecutionStartedEventAttributes>, IDeepCloneable<WorkflowExecutionStartedEventAttributes>, IBufferMessage, IMessage
Inheritance
WorkflowExecutionStartedEventAttributes
Implements
IBufferMessage
IMessage
Inherited Members

Constructors

WorkflowExecutionStartedEventAttributes()

public WorkflowExecutionStartedEventAttributes()

WorkflowExecutionStartedEventAttributes(WorkflowExecutionStartedEventAttributes)

public WorkflowExecutionStartedEventAttributes(WorkflowExecutionStartedEventAttributes other)

Parameters

other WorkflowExecutionStartedEventAttributes

Fields

AttemptFieldNumber

Field number for the "attempt" field.

public const int AttemptFieldNumber = 18

Field Value

int

ContinuedExecutionRunIdFieldNumber

Field number for the "continued_execution_run_id" field.

public const int ContinuedExecutionRunIdFieldNumber = 10

Field Value

int

ContinuedFailureFieldNumber

Field number for the "continued_failure" field.

public const int ContinuedFailureFieldNumber = 12

Field Value

int

CronScheduleFieldNumber

Field number for the "cron_schedule" field.

public const int CronScheduleFieldNumber = 20

Field Value

int

FirstExecutionRunIdFieldNumber

Field number for the "first_execution_run_id" field.

public const int FirstExecutionRunIdFieldNumber = 16

Field Value

int

FirstWorkflowTaskBackoffFieldNumber

Field number for the "first_workflow_task_backoff" field.

public const int FirstWorkflowTaskBackoffFieldNumber = 21

Field Value

int

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 25

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 15

Field Value

int

InitiatorFieldNumber

Field number for the "initiator" field.

public const int InitiatorFieldNumber = 11

Field Value

int

InputFieldNumber

Field number for the "input" field.

public const int InputFieldNumber = 6

Field Value

int

LastCompletionResultFieldNumber

Field number for the "last_completion_result" field.

public const int LastCompletionResultFieldNumber = 13

Field Value

int

MemoFieldNumber

Field number for the "memo" field.

public const int MemoFieldNumber = 22

Field Value

int

OriginalExecutionRunIdFieldNumber

Field number for the "original_execution_run_id" field.

public const int OriginalExecutionRunIdFieldNumber = 14

Field Value

int

ParentInitiatedEventIdFieldNumber

Field number for the "parent_initiated_event_id" field.

public const int ParentInitiatedEventIdFieldNumber = 4

Field Value

int

ParentInitiatedEventVersionFieldNumber

Field number for the "parent_initiated_event_version" field.

public const int ParentInitiatedEventVersionFieldNumber = 26

Field Value

int

ParentWorkflowExecutionFieldNumber

Field number for the "parent_workflow_execution" field.

public const int ParentWorkflowExecutionFieldNumber = 3

Field Value

int

ParentWorkflowNamespaceFieldNumber

Field number for the "parent_workflow_namespace" field.

public const int ParentWorkflowNamespaceFieldNumber = 2

Field Value

int

ParentWorkflowNamespaceIdFieldNumber

Field number for the "parent_workflow_namespace_id" field.

public const int ParentWorkflowNamespaceIdFieldNumber = 27

Field Value

int

PrevAutoResetPointsFieldNumber

Field number for the "prev_auto_reset_points" field.

public const int PrevAutoResetPointsFieldNumber = 24

Field Value

int

RetryPolicyFieldNumber

Field number for the "retry_policy" field.

public const int RetryPolicyFieldNumber = 17

Field Value

int

SearchAttributesFieldNumber

Field number for the "search_attributes" field.

public const int SearchAttributesFieldNumber = 23

Field Value

int

SourceVersionStampFieldNumber

Field number for the "source_version_stamp" field.

public const int SourceVersionStampFieldNumber = 29

Field Value

int

TaskQueueFieldNumber

Field number for the "task_queue" field.

public const int TaskQueueFieldNumber = 5

Field Value

int

WorkflowExecutionExpirationTimeFieldNumber

Field number for the "workflow_execution_expiration_time" field.

public const int WorkflowExecutionExpirationTimeFieldNumber = 19

Field Value

int

WorkflowExecutionTimeoutFieldNumber

Field number for the "workflow_execution_timeout" field.

public const int WorkflowExecutionTimeoutFieldNumber = 7

Field Value

int

WorkflowIdFieldNumber

Field number for the "workflow_id" field.

public const int WorkflowIdFieldNumber = 28

Field Value

int

WorkflowRunTimeoutFieldNumber

Field number for the "workflow_run_timeout" field.

public const int WorkflowRunTimeoutFieldNumber = 8

Field Value

int

WorkflowTaskTimeoutFieldNumber

Field number for the "workflow_task_timeout" field.

public const int WorkflowTaskTimeoutFieldNumber = 9

Field Value

int

WorkflowTypeFieldNumber

Field number for the "workflow_type" field.

public const int WorkflowTypeFieldNumber = 1

Field Value

int

Properties

Attempt

Starting at 1, the number of times we have tried to execute this workflow

public int Attempt { get; set; }

Property Value

int

ContinuedExecutionRunId

Run id of the previous workflow which continued-as-new or retired or cron executed into this workflow.

public string ContinuedExecutionRunId { get; set; }

Property Value

string

ContinuedFailure

public Failure ContinuedFailure { get; set; }

Property Value

Failure

CronSchedule

If this workflow runs on a cron schedule, it will appear here

public string CronSchedule { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FirstExecutionRunId

This is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset. Used to identify a chain.

public string FirstExecutionRunId { get; set; }

Property Value

string

FirstWorkflowTaskBackoff

For a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.

public Duration FirstWorkflowTaskBackoff { get; set; }

Property Value

Duration

Header

public Header Header { get; set; }

Property Value

Header

Identity

Identity of the client who requested this execution

public string Identity { get; set; }

Property Value

string

Initiator

public ContinueAsNewInitiator Initiator { get; set; }

Property Value

ContinueAsNewInitiator

Input

SDK will deserialize this and provide it as arguments to the workflow function

public Payloads Input { get; set; }

Property Value

Payloads

LastCompletionResult

public Payloads LastCompletionResult { get; set; }

Property Value

Payloads

Memo

public Memo Memo { get; set; }

Property Value

Memo

OriginalExecutionRunId

This is the run id when the WorkflowExecutionStarted event was written. A workflow reset changes the execution run_id, but preserves this field.

public string OriginalExecutionRunId { get; set; }

Property Value

string

ParentInitiatedEventId

EventID of the child execution initiated event in parent workflow

public long ParentInitiatedEventId { get; set; }

Property Value

long

ParentInitiatedEventVersion

Version of the child execution initiated event in parent workflow It should be used together with parent_initiated_event_id to identify a child initiated event for global namespace

public long ParentInitiatedEventVersion { get; set; }

Property Value

long

ParentWorkflowExecution

Contains information about parent workflow execution that initiated the child workflow these attributes belong to. If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.

public WorkflowExecution ParentWorkflowExecution { get; set; }

Property Value

WorkflowExecution

ParentWorkflowNamespace

If this workflow is a child, the namespace our parent lives in. SDKs and UI tools should use parent_workflow_namespace field but server must use parent_workflow_namespace_id only.

public string ParentWorkflowNamespace { get; set; }

Property Value

string

ParentWorkflowNamespaceId

public string ParentWorkflowNamespaceId { get; set; }

Property Value

string

Parser

public static MessageParser<WorkflowExecutionStartedEventAttributes> Parser { get; }

Property Value

MessageParser<WorkflowExecutionStartedEventAttributes>

PrevAutoResetPoints

public ResetPoints PrevAutoResetPoints { get; set; }

Property Value

ResetPoints

RetryPolicy

public RetryPolicy RetryPolicy { get; set; }

Property Value

RetryPolicy

SearchAttributes

public SearchAttributes SearchAttributes { get; set; }

Property Value

SearchAttributes

SourceVersionStamp

If this workflow intends to use anything other than the current overall default version for the queue, then we include it here.

public WorkerVersionStamp SourceVersionStamp { get; set; }

Property Value

WorkerVersionStamp

TaskQueue

public TaskQueue TaskQueue { get; set; }

Property Value

TaskQueue

WorkflowExecutionExpirationTime

The absolute time at which the workflow will be timed out. This is passed without change to the next run/retry of a workflow.

public Timestamp WorkflowExecutionExpirationTime { get; set; }

Property Value

Timestamp

WorkflowExecutionTimeout

Total workflow execution timeout including retries and continue as new.

public Duration WorkflowExecutionTimeout { get; set; }

Property Value

Duration

WorkflowId

This field is new in 1.21.

public string WorkflowId { get; set; }

Property Value

string

WorkflowRunTimeout

Timeout of a single workflow run.

public Duration WorkflowRunTimeout { get; set; }

Property Value

Duration

WorkflowTaskTimeout

Timeout of a single workflow task.

public Duration WorkflowTaskTimeout { get; set; }

Property Value

Duration

WorkflowType

public WorkflowType WorkflowType { get; set; }

Property Value

WorkflowType

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 WorkflowExecutionStartedEventAttributes Clone()

Returns

WorkflowExecutionStartedEventAttributes

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(WorkflowExecutionStartedEventAttributes)

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

public bool Equals(WorkflowExecutionStartedEventAttributes other)

Parameters

other WorkflowExecutionStartedEventAttributes

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(WorkflowExecutionStartedEventAttributes)

Merges the given message into this one.

public void MergeFrom(WorkflowExecutionStartedEventAttributes other)

Parameters

other WorkflowExecutionStartedEventAttributes

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.