Table of Contents

Class WorkerDeploymentOptions

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

Worker Deployment options set in SDK that need to be sent to server in every poll. Experimental. Worker Deployments are experimental and might significantly change in the future.

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

Constructors

WorkerDeploymentOptions() 

public WorkerDeploymentOptions()

WorkerDeploymentOptions(WorkerDeploymentOptions) 

public WorkerDeploymentOptions(WorkerDeploymentOptions other)

Parameters

other WorkerDeploymentOptions

Fields

BuildIdFieldNumber

Field number for the "build_id" field.

public const int BuildIdFieldNumber = 2

Field Value

int

DeploymentNameFieldNumber

Field number for the "deployment_name" field.

public const int DeploymentNameFieldNumber = 1

Field Value

int

WorkerVersioningModeFieldNumber

Field number for the "worker_versioning_mode" field.

public const int WorkerVersioningModeFieldNumber = 3

Field Value

int

Properties

BuildId

The Build ID of the worker. Required when worker_versioning_mode==VERSIONED, in which case, the worker will be part of a Deployment Version.

public string BuildId { get; set; }

Property Value

string

DeploymentName

Required. Worker Deployment name.

public string DeploymentName { get; set; }

Property Value

string

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser 

public static MessageParser<WorkerDeploymentOptions> Parser { get; }

Property Value

MessageParser<WorkerDeploymentOptions>

WorkerVersioningMode

Required. Versioning Mode for this worker. Must be the same for all workers with the same deployment_name and build_id combination, across all Task Queues. When worker_versioning_mode==VERSIONED, the worker will be part of a Deployment Version.

public WorkerVersioningMode WorkerVersioningMode { get; set; }

Property Value

WorkerVersioningMode

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

Returns

WorkerDeploymentOptions

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

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

public bool Equals(WorkerDeploymentOptions other)

Parameters

other WorkerDeploymentOptions

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

Merges the given message into this one.

public void MergeFrom(WorkerDeploymentOptions other)

Parameters

other WorkerDeploymentOptions

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.