Class StartWorkflowExecutionResponse

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

StartWorkflowExecutionResponse

Implements

IMessage<StartWorkflowExecutionResponse>

IEquatable<StartWorkflowExecutionResponse>

IDeepCloneable<StartWorkflowExecutionResponse>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

StartWorkflowExecutionResponse()

public StartWorkflowExecutionResponse()

StartWorkflowExecutionResponse(StartWorkflowExecutionResponse)

public StartWorkflowExecutionResponse(StartWorkflowExecutionResponse other)

Parameters

other StartWorkflowExecutionResponse

Fields

EagerWorkflowTaskFieldNumber

Field number for the "eager_workflow_task" field.

public const int EagerWorkflowTaskFieldNumber = 2

Field Value

int

LinkFieldNumber

Field number for the "link" field.

public const int LinkFieldNumber = 4

Field Value

int

RunIdFieldNumber

Field number for the "run_id" field.

public const int RunIdFieldNumber = 1

Field Value

int

StartedFieldNumber

Field number for the "started" field.

public const int StartedFieldNumber = 3

Field Value

int

StatusFieldNumber

Field number for the "status" field.

public const int StatusFieldNumber = 5

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EagerWorkflowTask

When request_eager_execution is set on the StartWorkflowExecutionRequest, the server - if supported - will return the first workflow task to be eagerly executed. The caller is expected to have a worker available to process the task.

public PollWorkflowTaskQueueResponse EagerWorkflowTask { get; set; }

Property Value

PollWorkflowTaskQueueResponse

Link

Link to the workflow event.

public Link Link { get; set; }

Property Value

Link

Parser

public static MessageParser<StartWorkflowExecutionResponse> Parser { get; }

Property Value

MessageParser<StartWorkflowExecutionResponse>

RunId

The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).

public string RunId { get; set; }

Property Value

string

Started

If true, a new workflow was started.

public bool Started { get; set; }

Property Value

bool

Status

Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).

public WorkflowExecutionStatus Status { get; set; }

Property Value

WorkflowExecutionStatus

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

Returns

StartWorkflowExecutionResponse

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

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

public bool Equals(StartWorkflowExecutionResponse other)

Parameters

other StartWorkflowExecutionResponse

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

Merges the given message into this one.

public void MergeFrom(StartWorkflowExecutionResponse other)

Parameters

other StartWorkflowExecutionResponse

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.