Class PollWorkflowExecutionUpdateResponse

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

PollWorkflowExecutionUpdateResponse

Implements

IMessage<PollWorkflowExecutionUpdateResponse>

IEquatable<PollWorkflowExecutionUpdateResponse>

IDeepCloneable<PollWorkflowExecutionUpdateResponse>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PollWorkflowExecutionUpdateResponse()

public PollWorkflowExecutionUpdateResponse()

PollWorkflowExecutionUpdateResponse(PollWorkflowExecutionUpdateResponse)

public PollWorkflowExecutionUpdateResponse(PollWorkflowExecutionUpdateResponse other)

Parameters

other PollWorkflowExecutionUpdateResponse

Fields

OutcomeFieldNumber

Field number for the "outcome" field.

public const int OutcomeFieldNumber = 1

Field Value

int

StageFieldNumber

Field number for the "stage" field.

public const int StageFieldNumber = 2

Field Value

int

UpdateRefFieldNumber

Field number for the "update_ref" field.

public const int UpdateRefFieldNumber = 3

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Outcome

The outcome of the update if and only if the update has completed. If this response is being returned before the update has completed (e.g. due to the specification of a wait policy that only waits on UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED) then this field will not be set.

public Outcome Outcome { get; set; }

Property Value

Outcome

Parser

public static MessageParser<PollWorkflowExecutionUpdateResponse> Parser { get; }

Property Value

MessageParser<PollWorkflowExecutionUpdateResponse>

Stage

The most advanced lifecycle stage that the Update is known to have reached, where lifecycle stages are ordered UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED. UNSPECIFIED will be returned if and only if the server's maximum wait time was reached before the Update reached the stage specified in the request WaitPolicy, and before the context deadline expired; clients may may then retry the call as needed.

public UpdateWorkflowExecutionLifecycleStage Stage { get; set; }

Property Value

UpdateWorkflowExecutionLifecycleStage

UpdateRef

Sufficient information to address this Update.

public UpdateRef UpdateRef { get; set; }

Property Value

UpdateRef

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

Returns

PollWorkflowExecutionUpdateResponse

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

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

public bool Equals(PollWorkflowExecutionUpdateResponse other)

Parameters

other PollWorkflowExecutionUpdateResponse

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

Merges the given message into this one.

public void MergeFrom(PollWorkflowExecutionUpdateResponse other)

Parameters

other PollWorkflowExecutionUpdateResponse

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.