Class UpdateWorkflowExecutionRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

(-- api-linter: core::0134=disabled aip.dev/not-precedent: Update RPCs don't follow Google API format. --)

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

Inheritance

object

UpdateWorkflowExecutionRequest

Implements

IMessage<UpdateWorkflowExecutionRequest>

IEquatable<UpdateWorkflowExecutionRequest>

IDeepCloneable<UpdateWorkflowExecutionRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

UpdateWorkflowExecutionRequest()

public UpdateWorkflowExecutionRequest()

UpdateWorkflowExecutionRequest(UpdateWorkflowExecutionRequest)

public UpdateWorkflowExecutionRequest(UpdateWorkflowExecutionRequest other)

Parameters

other UpdateWorkflowExecutionRequest

Fields

FirstExecutionRunIdFieldNumber

Field number for the "first_execution_run_id" field.

public const int FirstExecutionRunIdFieldNumber = 3

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

RequestFieldNumber

Field number for the "request" field.

public const int RequestFieldNumber = 5

Field Value

int

WaitPolicyFieldNumber

Field number for the "wait_policy" field.

public const int WaitPolicyFieldNumber = 4

Field Value

int

WorkflowExecutionFieldNumber

Field number for the "workflow_execution" field.

public const int WorkflowExecutionFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FirstExecutionRunId

If set, this call will error if the most recent (if no run id is set on workflow_execution), or specified (if it is) workflow execution is not part of the same execution chain as this id.

public string FirstExecutionRunId { get; set; }

Property Value

string

Namespace

The namespace name of the target workflow

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<UpdateWorkflowExecutionRequest> Parser { get; }

Property Value

MessageParser<UpdateWorkflowExecutionRequest>

Request

The request information that will be delivered all the way down to the workflow execution.

public Request Request { get; set; }

Property Value

Request

WaitPolicy

Describes when this request should return - basically whether the update is synchronous, asynchronous, or somewhere in between.

public WaitPolicy WaitPolicy { get; set; }

Property Value

WaitPolicy

WorkflowExecution

The target workflow id and (optionally) a specific run thereof (-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: false positive triggered by the word "optional" --)

public WorkflowExecution WorkflowExecution { get; set; }

Property Value

WorkflowExecution

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

Returns

UpdateWorkflowExecutionRequest

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

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

public bool Equals(UpdateWorkflowExecutionRequest other)

Parameters

other UpdateWorkflowExecutionRequest

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

Merges the given message into this one.

public void MergeFrom(UpdateWorkflowExecutionRequest other)

Parameters

other UpdateWorkflowExecutionRequest

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.