Table of Contents

Class Deployment

Namespace
Temporalio.Api.Deployment.V1
Assembly
Temporalio.dll

Deployment identifies a deployment of Temporal workers. The combination of deployment series name + build ID serves as the identifier. User can use WorkerDeploymentOptions in their worker programs to specify these values.

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

Constructors

Deployment()

public Deployment()

Deployment(Deployment)

public Deployment(Deployment other)

Parameters

other Deployment

Fields

BuildIdFieldNumber

Field number for the "build_id" field.

public const int BuildIdFieldNumber = 2

Field Value

int

SeriesNameFieldNumber

Field number for the "series_name" field.

public const int SeriesNameFieldNumber = 1

Field Value

int

Properties

BuildId

Build ID changes with each version of the worker when the worker program code and/or config changes.

public string BuildId { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<Deployment> Parser { get; }

Property Value

MessageParser<Deployment>

SeriesName

Different versions of the same worker service/application are related together by having a shared series name. Out of all deployments of a series, one can be designated as the current deployment, which receives new workflow executions and new tasks of workflows with VERSIONING_BEHAVIOR_AUTO_UPGRADE versioning behavior.

public string SeriesName { 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 Deployment Clone()

Returns

Deployment

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

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

public bool Equals(Deployment other)

Parameters

other Deployment

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

Merges the given message into this one.

public void MergeFrom(Deployment other)

Parameters

other Deployment

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.