Table of Contents

Class RoutingConfig

Namespace
Temporalio.Api.Deployment.V1
Assembly
Temporalio.dll
public sealed class RoutingConfig : IMessage<RoutingConfig>, IEquatable<RoutingConfig>, IDeepCloneable<RoutingConfig>, IBufferMessage, IMessage
Inheritance
RoutingConfig
Implements
IMessage<RoutingConfig>
IDeepCloneable<RoutingConfig>
IBufferMessage
IMessage
Inherited Members

Constructors

RoutingConfig() 

public RoutingConfig()

RoutingConfig(RoutingConfig) 

public RoutingConfig(RoutingConfig other)

Parameters

other RoutingConfig

Fields

CurrentDeploymentVersionFieldNumber

Field number for the "current_deployment_version" field.

public const int CurrentDeploymentVersionFieldNumber = 7

Field Value

int

CurrentVersionChangedTimeFieldNumber

Field number for the "current_version_changed_time" field.

public const int CurrentVersionChangedTimeFieldNumber = 4

Field Value

int

CurrentVersionFieldNumber

Field number for the "current_version" field.

public const int CurrentVersionFieldNumber = 1

Field Value

int

RampingDeploymentVersionFieldNumber

Field number for the "ramping_deployment_version" field.

public const int RampingDeploymentVersionFieldNumber = 9

Field Value

int

RampingVersionChangedTimeFieldNumber

Field number for the "ramping_version_changed_time" field.

public const int RampingVersionChangedTimeFieldNumber = 5

Field Value

int

RampingVersionFieldNumber

Field number for the "ramping_version" field.

public const int RampingVersionFieldNumber = 2

Field Value

int

RampingVersionPercentageChangedTimeFieldNumber

Field number for the "ramping_version_percentage_changed_time" field.

public const int RampingVersionPercentageChangedTimeFieldNumber = 6

Field Value

int

RampingVersionPercentageFieldNumber

Field number for the "ramping_version_percentage" field.

public const int RampingVersionPercentageFieldNumber = 3

Field Value

int

Properties

CurrentDeploymentVersion

Specifies which Deployment Version should receive new workflow executions and tasks of existing unversioned or AutoUpgrade workflows. Nil value means no Version in this Deployment (except Ramping Version, if present) receives traffic other than tasks of previously Pinned workflows. In absence of a Current Version, remaining traffic after any ramp (if set) goes to unversioned workers (those with UNVERSIONED (or unspecified) WorkerVersioningMode.). Note: Current Version is overridden by the Ramping Version for a portion of traffic when ramp percentage is non-zero (see ramping_deployment_version and ramping_version_percentage).

public WorkerDeploymentVersion CurrentDeploymentVersion { get; set; }

Property Value

WorkerDeploymentVersion

CurrentVersion

Deprecated. Use current_deployment_version.

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

Property Value

string

CurrentVersionChangedTime

Last time current version was changed.

public Timestamp CurrentVersionChangedTime { get; set; }

Property Value

Timestamp

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser 

public static MessageParser<RoutingConfig> Parser { get; }

Property Value

MessageParser<RoutingConfig>

RampingDeploymentVersion

When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version. Must always be different from current_deployment_version unless both are nil. Nil value represents all the unversioned workers (those with UNVERSIONED (or unspecified) WorkerVersioningMode.) Note that it is possible to ramp from one Version to another Version, or from unversioned workers to a particular Version, or from a particular Version to unversioned workers.

public WorkerDeploymentVersion RampingDeploymentVersion { get; set; }

Property Value

WorkerDeploymentVersion

RampingVersion

Deprecated. Use ramping_deployment_version.

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

Property Value

string

RampingVersionChangedTime

Last time ramping version was changed. Not updated if only the ramp percentage changes.

public Timestamp RampingVersionChangedTime { get; set; }

Property Value

Timestamp

RampingVersionPercentage

Percentage of tasks that are routed to the Ramping Version instead of the Current Version. Valid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but not yet "promoted" to be the Current Version, likely due to pending validations. A 0% value means the Ramping Version is receiving no traffic.

public float RampingVersionPercentage { get; set; }

Property Value

float

RampingVersionPercentageChangedTime

Last time ramping version percentage was changed. If ramping version is changed, this is also updated, even if the percentage stays the same.

public Timestamp RampingVersionPercentageChangedTime { get; set; }

Property Value

Timestamp

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

Returns

RoutingConfig

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

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

public bool Equals(RoutingConfig other)

Parameters

other RoutingConfig

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

Merges the given message into this one.

public void MergeFrom(RoutingConfig other)

Parameters

other RoutingConfig

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.