Class WorkerDeploymentInfo

Namespace

Temporalio.Api.Deployment.V1

Assembly

Temporalio.dll

A Worker Deployment (Deployment, for short) represents all workers serving a shared set of Task Queues. Typically, a Deployment represents one service or application. A Deployment contains multiple Deployment Versions, each representing a different version of workers. (see documentation of WorkerDeploymentVersionInfo) Deployment records are created in Temporal server automatically when their first poller arrives to the server. Experimental. Worker Deployments are experimental and might significantly change in the future.

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

Inheritance

object

WorkerDeploymentInfo

Implements

IMessage<WorkerDeploymentInfo>

IEquatable<WorkerDeploymentInfo>

IDeepCloneable<WorkerDeploymentInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkerDeploymentInfo()

public WorkerDeploymentInfo()

WorkerDeploymentInfo(WorkerDeploymentInfo)

public WorkerDeploymentInfo(WorkerDeploymentInfo other)

Parameters

other WorkerDeploymentInfo

Fields

CreateTimeFieldNumber

Field number for the "create_time" field.

public const int CreateTimeFieldNumber = 3

Field Value

int

LastModifierIdentityFieldNumber

Field number for the "last_modifier_identity" field.

public const int LastModifierIdentityFieldNumber = 5

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 1

Field Value

int

RoutingConfigFieldNumber

Field number for the "routing_config" field.

public const int RoutingConfigFieldNumber = 4

Field Value

int

VersionSummariesFieldNumber

Field number for the "version_summaries" field.

public const int VersionSummariesFieldNumber = 2

Field Value

int

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Property Value

Timestamp

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

LastModifierIdentity

Identity of the last client who modified the configuration of this Deployment. Set to the identity value sent by APIs such as SetWorkerDeploymentCurrentVersion and SetWorkerDeploymentRampingVersion.

public string LastModifierIdentity { get; set; }

Property Value

string

Name

Identifies a Worker Deployment. Must be unique within the namespace.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<WorkerDeploymentInfo> Parser { get; }

Property Value

MessageParser<WorkerDeploymentInfo>

RoutingConfig

public RoutingConfig RoutingConfig { get; set; }

Property Value

RoutingConfig

VersionSummaries

Deployment Versions that are currently tracked in this Deployment. A DeploymentVersion will be cleaned up automatically if all the following conditions meet:

• It does not receive new executions (is not current or ramping)
• It has no active pollers (see WorkerDeploymentVersionInfo.pollers_status)
• It is drained (see WorkerDeploymentVersionInfo.drainage_status)

public RepeatedField<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary> VersionSummaries { get; }

Property Value

RepeatedField<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary>

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

Returns

WorkerDeploymentInfo

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

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

public bool Equals(WorkerDeploymentInfo other)

Parameters

other WorkerDeploymentInfo

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

Merges the given message into this one.

public void MergeFrom(WorkerDeploymentInfo other)

Parameters

other WorkerDeploymentInfo

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.