Class VersioningOverride

Namespace

Temporalio.Api.Workflow.V1

Assembly

Temporalio.dll

Used to override the versioning behavior (and pinned deployment version, if applicable) of a specific workflow execution. If set, takes precedence over the worker-sent values. See WorkflowExecutionInfo.VersioningInfo for more information. To remove the override, call UpdateWorkflowExecutionOptions with a null VersioningOverride, and use the update_mask to indicate that it should be mutated.

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

Inheritance

object

VersioningOverride

Implements

IMessage<VersioningOverride>

IEquatable<VersioningOverride>

IDeepCloneable<VersioningOverride>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

VersioningOverride()

public VersioningOverride()

VersioningOverride(VersioningOverride)

public VersioningOverride(VersioningOverride other)

Parameters

other VersioningOverride

Fields

AutoUpgradeFieldNumber

Field number for the "auto_upgrade" field.

public const int AutoUpgradeFieldNumber = 4

Field Value

int

BehaviorFieldNumber

Field number for the "behavior" field.

public const int BehaviorFieldNumber = 1

Field Value

int

DeploymentFieldNumber

Field number for the "deployment" field.

public const int DeploymentFieldNumber = 2

Field Value

int

PinnedFieldNumber

Field number for the "pinned" field.

public const int PinnedFieldNumber = 3

Field Value

int

PinnedVersionFieldNumber

Field number for the "pinned_version" field.

public const int PinnedVersionFieldNumber = 9

Field Value

int

Properties

AutoUpgrade

Send the next workflow task to the Current Deployment Version of its Task Queue when the next workflow task is dispatched.

public bool AutoUpgrade { get; set; }

Property Value

bool

Behavior

Required. Deprecated. Use override.

[Obsolete]
public VersioningBehavior Behavior { get; set; }

Property Value

VersioningBehavior

Deployment

Required if behavior is PINNED. Must be null if behavior is AUTO_UPGRADE. Identifies the worker deployment to pin the workflow to. Deprecated. Use override.pinned.version.

[Obsolete]
public Deployment Deployment { get; set; }

Property Value

Deployment

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasAutoUpgrade

Gets whether the "auto_upgrade" field is set

public bool HasAutoUpgrade { get; }

Property Value

bool

OverrideCase

public VersioningOverride.OverrideOneofCase OverrideCase { get; }

Property Value

VersioningOverride.OverrideOneofCase

Parser

public static MessageParser<VersioningOverride> Parser { get; }

Property Value

MessageParser<VersioningOverride>

Pinned

Send the next workflow task to the Version specified in the override.

public VersioningOverride.Types.PinnedOverride Pinned { get; set; }

Property Value

VersioningOverride.Types.PinnedOverride

PinnedVersion

Required if behavior is PINNED. Must be absent if behavior is not PINNED. Identifies the worker deployment version to pin the workflow to, in the format "<deployment_name>.<build_id>". Deprecated. Use override.pinned.version.

[Obsolete]
public string PinnedVersion { get; set; }

Property Value

string

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.

ClearAutoUpgrade()

Clears the value of the oneof if it's currently set to "auto_upgrade"

public void ClearAutoUpgrade()

ClearOverride()

public void ClearOverride()

Clone()

Creates a deep clone of this object.

public VersioningOverride Clone()

Returns

VersioningOverride

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

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

public bool Equals(VersioningOverride other)

Parameters

other VersioningOverride

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

Merges the given message into this one.

public void MergeFrom(VersioningOverride other)

Parameters

other VersioningOverride

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.