Class VersioningOverride.Types.OneTimeOverride

Namespace

Temporalio.Api.Workflow.V1

Assembly

Temporalio.dll

Routes Workflow Tasks for this execution to target_deployment_version until a Workflow Task completes on that version, then clears the override.

This does not force the workflow's normal Versioning Behavior to become Pinned. After the Workflow Task completes on target_deployment_version, the workflow execution's normal Versioning Behavior and Deployment Version are taken from the worker's completion response.

Example: if an execution is one-time moved from version X to version Y, and version Z later becomes current:

• if worker Y reports Pinned, the execution stays on Y;
• if worker Y reports AutoUpgrade, the execution routes to Z on a future Workflow Task;
• if worker Y reports Pinned and the workflow uses upgrade-on-continue-as-new, the current run stays on Y and the execution can route to Z after continue-as-new.

If no Workflow Task completes on target_deployment_version, this override remains pending.

public sealed class VersioningOverride.Types.OneTimeOverride : IMessage<VersioningOverride.Types.OneTimeOverride>, IEquatable<VersioningOverride.Types.OneTimeOverride>, IDeepCloneable<VersioningOverride.Types.OneTimeOverride>, IBufferMessage, IMessage

Inheritance

object

VersioningOverride.Types.OneTimeOverride

Implements

IMessage<VersioningOverride.Types.OneTimeOverride>

IEquatable<VersioningOverride.Types.OneTimeOverride>

IDeepCloneable<VersioningOverride.Types.OneTimeOverride>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

OneTimeOverride()

public OneTimeOverride()

OneTimeOverride(OneTimeOverride)

public OneTimeOverride(VersioningOverride.Types.OneTimeOverride other)

Parameters

other VersioningOverride.Types.OneTimeOverride

Fields

TargetDeploymentVersionFieldNumber

Field number for the "target_deployment_version" field.

public const int TargetDeploymentVersionFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<VersioningOverride.Types.OneTimeOverride> Parser { get; }

Property Value

MessageParser<VersioningOverride.Types.OneTimeOverride>

TargetDeploymentVersion

Required. Worker Deployment Version to receive the one-time Workflow Task.

public WorkerDeploymentVersion TargetDeploymentVersion { get; set; }

Property Value

WorkerDeploymentVersion

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 VersioningOverride.Types.OneTimeOverride Clone()

Returns

VersioningOverride.Types.OneTimeOverride

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

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

public bool Equals(VersioningOverride.Types.OneTimeOverride other)

Parameters

other VersioningOverride.Types.OneTimeOverride

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

Merges the given message into this one.

public void MergeFrom(VersioningOverride.Types.OneTimeOverride other)

Parameters

other VersioningOverride.Types.OneTimeOverride

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.