Class WorkerVersionCapabilities

Namespace

Temporalio.Api.Common.V1

Assembly

Temporalio.dll

Identifies the version(s) that a worker is compatible with when polling or identifying itself, and whether or not this worker is opting into the build-id based versioning feature. This is used by matching to determine which workers ought to receive what tasks.

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

Inheritance

object

WorkerVersionCapabilities

Implements

IMessage<WorkerVersionCapabilities>

IEquatable<WorkerVersionCapabilities>

IDeepCloneable<WorkerVersionCapabilities>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkerVersionCapabilities()

public WorkerVersionCapabilities()

WorkerVersionCapabilities(WorkerVersionCapabilities)

public WorkerVersionCapabilities(WorkerVersionCapabilities other)

Parameters

other WorkerVersionCapabilities

Fields

BuildIdFieldNumber

Field number for the "build_id" field.

public const int BuildIdFieldNumber = 1

Field Value

int

UseVersioningFieldNumber

Field number for the "use_versioning" field.

public const int UseVersioningFieldNumber = 2

Field Value

int

Properties

BuildId

An opaque whole-worker identifier

public string BuildId { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<WorkerVersionCapabilities> Parser { get; }

Property Value

MessageParser<WorkerVersionCapabilities>

UseVersioning

If set, the worker is opting in to worker versioning, and wishes to only receive appropriate tasks.

public bool UseVersioning { get; set; }

Property Value

bool

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

Returns

WorkerVersionCapabilities

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

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

public bool Equals(WorkerVersionCapabilities other)

Parameters

other WorkerVersionCapabilities

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

Merges the given message into this one.

public void MergeFrom(WorkerVersionCapabilities other)

Parameters

other WorkerVersionCapabilities

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.