Table of Contents

Class SetWorkerDeploymentRampingVersionRequest

Namespace
Temporalio.Api.WorkflowService.V1
Assembly
Temporalio.dll

Set/unset the Ramping Version of a Worker Deployment and its ramp percentage.

public sealed class SetWorkerDeploymentRampingVersionRequest : IMessage<SetWorkerDeploymentRampingVersionRequest>, IEquatable<SetWorkerDeploymentRampingVersionRequest>, IDeepCloneable<SetWorkerDeploymentRampingVersionRequest>, IBufferMessage, IMessage
Inheritance
SetWorkerDeploymentRampingVersionRequest
Implements
IBufferMessage
IMessage
Inherited Members

Constructors

SetWorkerDeploymentRampingVersionRequest() 

public SetWorkerDeploymentRampingVersionRequest()

SetWorkerDeploymentRampingVersionRequest(SetWorkerDeploymentRampingVersionRequest) 

public SetWorkerDeploymentRampingVersionRequest(SetWorkerDeploymentRampingVersionRequest other)

Parameters

other SetWorkerDeploymentRampingVersionRequest

Fields

BuildIdFieldNumber

Field number for the "build_id" field.

public const int BuildIdFieldNumber = 8

Field Value

int

ConflictTokenFieldNumber

Field number for the "conflict_token" field.

public const int ConflictTokenFieldNumber = 5

Field Value

int

DeploymentNameFieldNumber

Field number for the "deployment_name" field.

public const int DeploymentNameFieldNumber = 2

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 6

Field Value

int

IgnoreMissingTaskQueuesFieldNumber

Field number for the "ignore_missing_task_queues" field.

public const int IgnoreMissingTaskQueuesFieldNumber = 7

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

PercentageFieldNumber

Field number for the "percentage" field.

public const int PercentageFieldNumber = 4

Field Value

int

VersionFieldNumber

Field number for the "version" field.

public const int VersionFieldNumber = 3

Field Value

int

Properties

BuildId

The build id of the Version that you want to ramp traffic to. Pass an empty value to set the Ramping Version to nil. A nil Ramping Version represents all the unversioned workers (those with UNVERSIONED (or unspecified) WorkerVersioningMode.)

public string BuildId { get; set; }

Property Value

string

ConflictToken

Optional. This can be the value of conflict_token from a Describe, or another Worker Deployment API. Passing a non-nil conflict token will cause this request to fail if the Deployment's configuration has been modified between the API call that generated the token and this one.

public ByteString ConflictToken { get; set; }

Property Value

ByteString

DeploymentName 

public string DeploymentName { get; set; }

Property Value

string

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Identity

Optional. The identity of the client who initiated this request.

public string Identity { get; set; }

Property Value

string

IgnoreMissingTaskQueues

Optional. By default this request would be rejected if not all the expected Task Queues are being polled by the new Version, to protect against accidental removal of Task Queues, or worker health issues. Pass true here to bypass this protection. The set of expected Task Queues equals to all the Task Queues ever polled from the existing Current Version of the Deployment, with the following exclusions:

  • Task Queues that are not used anymore (inferred by having empty backlog and a task add_rate of 0.)
  • Task Queues that are moved to another Worker Deployment (inferred by the Task Queue having a different Current Version than the Current Version of this deployment.) WARNING: Do not set this flag unless you are sure that the missing task queue poller are not needed. If the request is unexpectedly rejected due to missing pollers, then that means the pollers have not reached to the server yet. Only set this if you expect those pollers to never arrive. Note: this check only happens when the ramping version is about to change, not every time that the percentage changes. Also note that the check is against the deployment's Current Version, not the previous Ramping Version.
public bool IgnoreMissingTaskQueues { get; set; }

Property Value

bool

Namespace 

public string Namespace { get; set; }

Property Value

string

Parser 

public static MessageParser<SetWorkerDeploymentRampingVersionRequest> Parser { get; }

Property Value

MessageParser<SetWorkerDeploymentRampingVersionRequest>

Percentage

Ramp percentage to set. Valid range: [0,100].

public float Percentage { get; set; }

Property Value

float

Version

Deprecated. Use build_id.

[Obsolete]
public string Version { 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.

Clone()

Creates a deep clone of this object.

public SetWorkerDeploymentRampingVersionRequest Clone()

Returns

SetWorkerDeploymentRampingVersionRequest

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

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

public bool Equals(SetWorkerDeploymentRampingVersionRequest other)

Parameters

other SetWorkerDeploymentRampingVersionRequest

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

Merges the given message into this one.

public void MergeFrom(SetWorkerDeploymentRampingVersionRequest other)

Parameters

other SetWorkerDeploymentRampingVersionRequest

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.