Class WorkerDeploymentVersion

Namespace

Temporalio.Common

Assembly

Temporalio.dll

Represents the version of a specific worker deployment.

public sealed record WorkerDeploymentVersion : IEquatable<WorkerDeploymentVersion>

Inheritance

object

WorkerDeploymentVersion

Implements

IEquatable<WorkerDeploymentVersion>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Deployment-based versioning is experimental and APIs may change.

Constructors

WorkerDeploymentVersion(string, string)

Represents the version of a specific worker deployment.

public WorkerDeploymentVersion(string DeploymentName, string BuildId)

Parameters

DeploymentName string

BuildId string

Remarks

WARNING: Deployment-based versioning is experimental and APIs may change.

Properties

BuildId

public string BuildId { get; init; }

Property Value

string

DeploymentName

public string DeploymentName { get; init; }

Property Value

string

Methods

FromCanonicalString(string)

Parse a version from a canonical string, which must be in the format:

deployment_name.build_id

Deployment name must not have a . in it.

public static WorkerDeploymentVersion FromCanonicalString(string canonical)

Parameters

canonical string

The canonical string to parse.

Returns

WorkerDeploymentVersion

A new WorkerDeploymentVersion instance.

Exceptions

ArgumentException

Thrown when the canonical string is not in the expected format.

ToCanonicalString()

Returns the canonical string representation of the version.

public string ToCanonicalString()

Returns

string

The canonical string representation.