Class DeleteWorkerDeploymentVersionRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

Used for manual deletion of Versions. User can delete a Version only when all the following conditions are met:

• It is not the Current or Ramping Version of its Deployment.
• It has no active pollers (none of the task queues in the Version have pollers)
• It is not draining (see WorkerDeploymentVersionInfo.drainage_info). This condition can be skipped by passing skip-drainage=true.

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

Inheritance

object

DeleteWorkerDeploymentVersionRequest

Implements

IMessage<DeleteWorkerDeploymentVersionRequest>

IEquatable<DeleteWorkerDeploymentVersionRequest>

IDeepCloneable<DeleteWorkerDeploymentVersionRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

DeleteWorkerDeploymentVersionRequest()

public DeleteWorkerDeploymentVersionRequest()

DeleteWorkerDeploymentVersionRequest(DeleteWorkerDeploymentVersionRequest)

public DeleteWorkerDeploymentVersionRequest(DeleteWorkerDeploymentVersionRequest other)

Parameters

other DeleteWorkerDeploymentVersionRequest

Fields

DeploymentVersionFieldNumber

Field number for the "deployment_version" field.

public const int DeploymentVersionFieldNumber = 5

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 4

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

SkipDrainageFieldNumber

Field number for the "skip_drainage" field.

public const int SkipDrainageFieldNumber = 3

Field Value

int

VersionFieldNumber

Field number for the "version" field.

public const int VersionFieldNumber = 2

Field Value

int

Properties

DeploymentVersion

Required.

public WorkerDeploymentVersion DeploymentVersion { get; set; }

Property Value

WorkerDeploymentVersion

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

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<DeleteWorkerDeploymentVersionRequest> Parser { get; }

Property Value

MessageParser<DeleteWorkerDeploymentVersionRequest>

SkipDrainage

Pass to force deletion even if the Version is draining. In this case the open pinned workflows will be stuck until manually moved to another version by UpdateWorkflowExecutionOptions.

public bool SkipDrainage { get; set; }

Property Value

bool

Version

Deprecated. Use deployment_version.

[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 DeleteWorkerDeploymentVersionRequest Clone()

Returns

DeleteWorkerDeploymentVersionRequest

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

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

public bool Equals(DeleteWorkerDeploymentVersionRequest other)

Parameters

other DeleteWorkerDeploymentVersionRequest

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

Merges the given message into this one.

public void MergeFrom(DeleteWorkerDeploymentVersionRequest other)

Parameters

other DeleteWorkerDeploymentVersionRequest

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.