Class NewWorkflowExecutionInfo

Namespace

Temporalio.Api.Workflow.V1

Assembly

Temporalio.dll

NewWorkflowExecutionInfo is a shared message that encapsulates all the required arguments to starting a workflow in different contexts.

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

Inheritance

object

NewWorkflowExecutionInfo

Implements

IMessage<NewWorkflowExecutionInfo>

IEquatable<NewWorkflowExecutionInfo>

IDeepCloneable<NewWorkflowExecutionInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

NewWorkflowExecutionInfo()

public NewWorkflowExecutionInfo()

NewWorkflowExecutionInfo(NewWorkflowExecutionInfo)

public NewWorkflowExecutionInfo(NewWorkflowExecutionInfo other)

Parameters

other NewWorkflowExecutionInfo

Fields

CronScheduleFieldNumber

Field number for the "cron_schedule" field.

public const int CronScheduleFieldNumber = 10

Field Value

int

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 13

Field Value

int

InputFieldNumber

Field number for the "input" field.

public const int InputFieldNumber = 4

Field Value

int

MemoFieldNumber

Field number for the "memo" field.

public const int MemoFieldNumber = 11

Field Value

int

RetryPolicyFieldNumber

Field number for the "retry_policy" field.

public const int RetryPolicyFieldNumber = 9

Field Value

int

SearchAttributesFieldNumber

Field number for the "search_attributes" field.

public const int SearchAttributesFieldNumber = 12

Field Value

int

TaskQueueFieldNumber

Field number for the "task_queue" field.

public const int TaskQueueFieldNumber = 3

Field Value

int

UserMetadataFieldNumber

Field number for the "user_metadata" field.

public const int UserMetadataFieldNumber = 14

Field Value

int

WorkflowExecutionTimeoutFieldNumber

Field number for the "workflow_execution_timeout" field.

public const int WorkflowExecutionTimeoutFieldNumber = 5

Field Value

int

WorkflowIdFieldNumber

Field number for the "workflow_id" field.

public const int WorkflowIdFieldNumber = 1

Field Value

int

WorkflowIdReusePolicyFieldNumber

Field number for the "workflow_id_reuse_policy" field.

public const int WorkflowIdReusePolicyFieldNumber = 8

Field Value

int

WorkflowRunTimeoutFieldNumber

Field number for the "workflow_run_timeout" field.

public const int WorkflowRunTimeoutFieldNumber = 6

Field Value

int

WorkflowTaskTimeoutFieldNumber

Field number for the "workflow_task_timeout" field.

public const int WorkflowTaskTimeoutFieldNumber = 7

Field Value

int

WorkflowTypeFieldNumber

Field number for the "workflow_type" field.

public const int WorkflowTypeFieldNumber = 2

Field Value

int

Properties

CronSchedule

See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/

public string CronSchedule { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Header

public Header Header { get; set; }

Property Value

Header

Input

Serialized arguments to the workflow.

public Payloads Input { get; set; }

Property Value

Payloads

Memo

public Memo Memo { get; set; }

Property Value

Memo

Parser

public static MessageParser<NewWorkflowExecutionInfo> Parser { get; }

Property Value

MessageParser<NewWorkflowExecutionInfo>

RetryPolicy

The retry policy for the workflow. Will never exceed workflow_execution_timeout.

public RetryPolicy RetryPolicy { get; set; }

Property Value

RetryPolicy

SearchAttributes

public SearchAttributes SearchAttributes { get; set; }

Property Value

SearchAttributes

TaskQueue

public TaskQueue TaskQueue { get; set; }

Property Value

TaskQueue

UserMetadata

Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionConfig for use by user interfaces to display the fixed as-of-start summary and details of the workflow.

public UserMetadata UserMetadata { get; set; }

Property Value

UserMetadata

WorkflowExecutionTimeout

Total workflow execution timeout including retries and continue as new.

public Duration WorkflowExecutionTimeout { get; set; }

Property Value

Duration

WorkflowId

public string WorkflowId { get; set; }

Property Value

string

WorkflowIdReusePolicy

Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

public WorkflowIdReusePolicy WorkflowIdReusePolicy { get; set; }

Property Value

WorkflowIdReusePolicy

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

Returns

NewWorkflowExecutionInfo

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

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

public bool Equals(NewWorkflowExecutionInfo other)

Parameters

other NewWorkflowExecutionInfo

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

Merges the given message into this one.

public void MergeFrom(NewWorkflowExecutionInfo other)

Parameters

other NewWorkflowExecutionInfo

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.